Scroll export button | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
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: May 2022October 2023 WMS Version: 5.0X / 46.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:
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:
|
Warning |
---|
If WMS version of your PBX is 4.02.44435.37 and higher and 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.
We also provide a JavaScript library and documentation for web developers to integrate Wildix Unified Communications capabilities into web applications and external software (CRM, ERP, Fias/Fidelio).
Requirements
- Wildix PBX
- Min. UC-Business License, in case of Collaboration license on the PBX Min. UC-Business License (https://www.wildix.com/licensing/) (see more on the page https://www.wildix.com/licensing/)
- Min. x-bees Standard License, in case of x-bees license on the PBX (see more in x-bees Admin Guide)
Note |
---|
Both Wallboard and Hotel Manager require a UC-Premium / x-bees SuperBee license. |
Developer Documentation and JavaScript Library Anchorjslib jslib
jslib | |
jslib |
...
Developer's Documentation: https://webapi.wildix.com/v2/doc/.
Read also: PBX Control APIs.
Deprecated version (prior to WMS 5.02.20201015.2)
...
Developer’s Documentation is available online.
Read also: PBX Control APIs.
Access WebAPI Demo
You have several options to access WebAPI demo:
...
- Go to WMS Settings -> PBX -> Integrations
- Select OAuth Applications -> OAuth 2.0 applications tab tab
Click Add to create a new application
Enter Application Name and Redirect URI https://webapi.wildix.com/v2/oauth2redirect.html
...
Click Save to add the application
Copy Application ID, you need it for the next step:
Step 2. Login to WebAPI
Enter the following data:
...
Warning |
---|
Starting from March 2018, the latest versions of the most popular web browsers drop support for cross-requests for the protocol schema "file://". To continue using Hotel Manager and Wallboard, you need to add the domain to the whitelist in WMS Settings -> PBX -> Security; see documentation: Domain Whitelist (Allow Origin). In case you are using Wildix online demo available at webapi.wildix.com add the domain webapi.wildix.com to the whitelist. In case you are using WebAPI uploaded on your web server, add your server domain to whitelist. |
...
Note |
---|
Note: This version of Wallboard is an online demo, which can be used "as is". We provide a JavaScript library which allows a web developer to fully customize this template. Read the chapter Developer Documentation. |
Warning |
---|
For access to Wallboard, read the chapter Access WebAPI Demo. |
Example of Wallboard and explanation of counters:
...
- 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 roster 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 roasterroster, 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
...