Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scroll export button
scopecurrent
template-id0fa09813-8b86-460a-aa1d-ef450a80e9ce
quick-starttrue
add-onScroll PDF Exporter

...

Info

This document explains how to add and use Collaboration WebAPI which allow integrating of Wildix Unified Communications capabilities into web applications and external software (CRM, ERP, Fias/Fidelio).

Updated:  October 2023

WMS Version: 5.0X / 6.0X

Permalink: https://wildix.atlassian.net/wiki/x/MA-OAQ


Warning

Starting from WMS v. 5.02.20201015.2, a new version of the library is available. The library supports the new oAuth2 authorization and it is recommended to use it in order to ensure more secure performance of your integrations. 

...

Warning

Please pay attention that WebAPI has been moved to a new dedicated server https://webapi.wildix.com/. Now you can access it at:

In order to ensure the correct WebAPI performance, proceed with these steps:

  1. Add https://webapi.wildix.com/ to PBX whitelist in WMS Settings -> PBX -> Security

  2. Only if you use the new WebAPI version: change Redirect URI to https://webapi.wildix.com/v2/oauth2redirect.html in WMS Settings -> Integrations -> OAuth 2.0 applications

Note: the access to WebAPI on wildix.com is extended til 2 May 2021. Up to this date, you need to replace the used links (e.g. https://www.wildix.com/webapi/wtapi.min.js) to ensure your integration continues working. 

It is recommended using PBX as a source:

  • https://{PBX_DOMAIN}/public/wtapi.js - the old version
  • https://{PBX_DOMAIN}/public/wtapi.v2.js - the new version


Warning
If you have previously downloaded and integrated WebAPI JavaScript Library, you need to update it manually in order to ensure compatibility with the new Presence Server (available starting from the mentioned WMS version).

...

Table of Contents

Introduction 

Collaboration WebAPI is a working demo which you can start using today on your Wildix PBX.

...

  • Green = available
  • Light blue = not connected to Collaboration/ x-bees or user not added to roster 

    Note

    If monitored users are not added to roaster of a manager (the user whose credentials are used to access Wallboard), their user statuses are displayed as "Offline" with Light blue icon regardless their actual user statutes (ringing/ talking/ paused etc).
    If monitored users are not connected to Collaboration/ x-bees, but added to roaster, then only "Offline" status are displayed with Light Blue icon, while other statuses are displayed with the appropriate icons. So, if a user has a connected WP device, but is not logged into Collaboration/ x-bees, when the phone is ringing, Light Blue icon changes to Red phone icon etc.


  • Red phone icon = talking on the phone
  • Clock icon = away
  • Brick icon = do not disturb
  • Pause icon = on pause;
  • Green phone icon with red arrow = incoming call

...