This document explains how to add and use 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 |
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. |
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:
|
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). |
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).
Both Wallboard and Hotel Manager require a UC-Premium / x-bees SuperBee license. |
Starting from WMS v. 5.02.20201015.2, a new version of the library is available. The library supports oAuth2 authorization and it is recommended to use it in order to ensure more secure performance of your integrations.
Download the library:
Developer's Documentation: https://webapi.wildix.com/v2/doc/.
Read also: PBX Control APIs.
Deprecated version (prior to WMS 5.02.20201015.2)
You can download the JavaScript library from the dedicated server or directly from your Wildix PBX using this path:
https://{PBX_IP}/public/wtapi.js
Developer’s Documentation is available online.
Read also: PBX Control APIs.
You have several options to access WebAPI demo:
Option 1 - use our online demo version, available at https://webapi.wildix.com/v2/ (the new version)/ https://webapi.wildix.com/v1/(the previous version).
Note that online demo version is not designed for any production purposes as it is just an example of how the integration can perform. You can use PBX as a source instead:
|
Recommendations on how to access the new version:
Step 1. Add new OAuth2 application for authentication
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:
For Hotel Manager, you can use the direct link: https://webapi.wildix.com/v2/hotelManager/index.html (the new version)/ hhttps://webapi.wildix.com/v1/hotelManager/index.html (the old version).
Note: Hotel Manager requires a special Dialplan configuration, find an example here. |
For Wallboard, you can use the direct link: https://webapi.wildix.com/v2/wallboard/index.html (the news version)/ https://webapi.wildix.com/v1/wallboard/index.html (the old version).
Click Settings and fill in the fields:
Version 1:
Version 2:
Ports to open for connection to Hotel Manager and Wallboard: 443 or custom secure port. If the PBX is local, there is no need to set port forwarding or open ports on firewall, you can access the Wildix WebAPI online demo locally with .*wildixin.com domain:
For example, if you add -2 for LAN port -> if the interface has the IP 192.168.0.1 then myhotel-2.wildixin.com will be resolved as 192.168.0.1; if the interface has the IP 10.135.0.1 then myhotel-1.wildixin.com will be resolved as 10.135.0.1 (in this example "myhotel" is the *.wildixin.com domain name of the PBX; use your PBX name instead). For remote connection you need anyway to open TCP port for HTTPS, and in this case you can use HTTPs and port 80 to connect. Example: https://mypbx.com:80/ or custom secure port https://mypbx.com:433 (or another custom secure port, specified on the page SIP-RTP in WMS). |
Option 2 - upload WebAPI to a web server reachable via HTTP/HTTPS
Option 3 - upload WebAPI on the PBX:
copy the folder of your application (e.g. Hotel Manager or Wallboard) to /home/admin using the command scp
For WebAPI version 2, make sure to copy wtapi.v2.js and oauth2redirect.html files. |
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. |
WebAPI library consists of four plugins:
Call groups plugin usage notes:
|
WebAPI library includes three additional modules:
Predictive Dialer allows you to generate a number of outgoing calls equal to the number of free call agents plus a number of spare calls.
The number of spare calls allows boosting the call center performance by pre-dialing final customers.
Immediately after answer, a final customer can hear a message informing him/her that their call is forwarded to a call agent. While waiting for the answer, either music on hold or a ringback is reproduced.
Features:
Note: Predictive Dialer requires a special Dialplan configuration, for more details contact Wildix Tech Support or post your request on Wildix Tech Wizards Facebook Group. |
User who needs to access Hotel Manager should be assigned at least a Business license. If you also need to use call billing feature, you need a Premium license (CDR-View). |
For access to Hotel Manager, read the chapter Access WebAPI Demo. |
Features currently supported:
Only users of "admin" type can set wake up calls, check-in / check-out and set make-up room status. |
For more information about Hotel Manager, read Hotel Manager Guide
Note: If you are looking for Fias Hotel integration, read documentation: Hotel Integration - FIAS protocol. |
User who needs to access Wallboard should be assigned a Premium license. |
Full list of supported features: https://www.wildix.com/call-center-wallboard/.
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. |
For access to Wallboard, read the chapter Access WebAPI Demo. |
Example of Wallboard and explanation of counters:
The counters start once you connect.
Add / remove a call agent: click on + (the 1st column) and add an extension.
Incoming calls waiting in queue are displayed below the table in red color.
User status icons legend:
Light blue = not connected to Collaboration/ x-bees or user not added to roster
If monitored users are not added to 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). |
Note: After changing any Call group parameters in WMS, the actual change on Wallboard appears with ~10s delay. |