Html |
---|
<div id="fb-root"></div> <script>(function(d, s, id) { var js, fjs = d.getElementsByTagName(s)[0]; if (d.getElementById(id)) return; js = d.createElement(s); js.id = id; js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.11'; fjs.parentNode.insertBefore(js, fjs); }(document, 'script', 'facebook-jssdk'));</script> |
...
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: December 2020March 2021 WMS Version: 5.0X / 4.0X Permalink: https://confluence.wildix.com/x/MwFuAQ |
Warning |
---|
If WMS version of your PBX is 4 Starting from WMS v. 5.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). |
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 WebAPI, you need to add the domain (Wildix domain in format www.wildix.com in case you are using our online demo and your domain in case you are using WebAPI on your web server) to the whitelist in WMS Settings -> PBX -> Security; see documentation: Domain Whitelist (Allow Origin). If you are having issues with accessing Wallboard or Hotel Manager, read the chapter Access WebAPI Demo. |
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 (https://www.wildix.com/licensing/)
Note |
---|
Both Wallboard and Hotel Manager require a Premium license. |
...
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. Download the library:from the Wildix website: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:
|
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 (https://www.wildix.com/
...
Developer's Documentation: https://www.wildix.com/webapi/v2/demo/doc/.
You can download the JavaScript library from the Wildix website or directly from your Wildix PBX using this path:
Note |
---|
Both Wallboard and Hotel Manager require a Premium license. |
Developer Documentation and JavaScript Library Anchor jslib jslib
jslib | |
jslib |
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:
- from the dedicated server: https://webapi.wildix.com/v2/wtapi.tar.gz
- directly from your Wildix PBX using the path: https://{PBX_IP}/public/wtapi.v2.js
Developer’s Documentation is available onlineDeveloper's Documentation: https://webapi.wildix.com/v2/doc/.
Read also: PBX Control APIs.
Deprecated vesrsion version (prior to WMS 5.02.20201015.2)
You can download the JavaScript library from the Wildix website 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.
...
Option 1 - use our online demo version, available at https://webapi.wildix.com/webapiv2/# (the previous new version) / https://wwwwebapi.wildix.com/webapi/v2/demov1/ (the new previous version)
For Hotel Manager, you can use the direct link: https://www.wildix.com/webapi/hotelManager/
Note |
---|
Note: Hotel Manager requires a special Dialplan configuration, find an example here. |
For Wallboard, you can use the direct link: .
Recommendations on how to access to the new version:
Step 1. Add new OAuth2 application for authentication
- Go to WMS Settings -> PBX -> Integrations
- Select OAuth 2.0 applications tab
Click Add to create a new application
Enter Application Name and Redirect URI https://www.wildix.com/webapi/
...
Click “Settings” and fill in the fields:
- Host: your PBX name
- Extension: extension of user
- Password: WEB password of user
- Callgroup ID: enter the IDs of 1 or more callgroups you want to monitor; SLA wait / percentage parameters are optional
Note |
---|
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:
- download the JavaScript library as described in the previous chapter
- connect to the PBX via SSH
- create the folder (if it doesn't exist yet) /var/www/scripts copy the folder of your application (e.g. Hotel Manager
v2/demo/oauth2redirect.html:
Click Save to add the application
Copy Application ID, you need for the next step:
Step 2. Login
Enter the following data:
- PBX host
- OAuth Application ID: the one you copy in Step 1
- Click Connect
- Click Yes
For Hotel Manager, you can use the direct link: https://webapi.wildix.com/v2/hotelManager/index.html (the new version)/ https://www.wildix.com/webapi/hotelManager/ (the old version).
Note |
---|
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://www.wildix.com/webapi/wallboard/ (the old version).
Click Settings and fill in the fields:
Version 1:
- Host: your PBX name
- Extension: extension of user
- Password: WEB password of user
- Callgroup ID: enter the IDs of 1 or more callgroups you want to monitor; SLA wait / percentage parameters are optional
Version 2:
- Host: your PBX name
- OAuth 2.0 Application ID: ID for authentication
- Redirect URI is hardcoded
- Callgroup ID: enter the IDs of 1 or more callgroups you want to monitor; SLA wait / percentage parameters are optional
Note |
---|
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:
- download the JavaScript library as described in the previous chapter
- connect to the PBX via SSH
- create the folder (if it doesn't exist yet) /var/www/scripts
copy the folder of your application (e.g. Hotel Manager or Wallboard) to /home/admin using the command scp
Note For WebAPI version 2, make sure to copy wtapi.v2.js and oauth2redirect.html files.
- move the folder via SSH from /home/admin to /var/www/scripts using the command mv
- edit the owner (chown wms:wms -R /var/www/scripts)
- now you can access the page by this link: https://your_PBX/scripts/application_folder/index.html
...
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 wwwat webapi.wildix.com /webapi, add the domain wwwadd the domain webapi.wildix.com to com to the whitelist. In case you are using WebAPI uploaded on your web server, add your server domain to whitelist. |
...
Note |
---|
Call groups plugin usage notes:
|
WebAPI library includes three additional modules:
- Predictive Dialer
- Hotel Manager
- Call center Wallboard
Predictive Dialer
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.
...
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:
- Start/stop calling the customers
- Manage the call agents and monitor their realtime status
- See the number of called customers waiting for an answer
Note |
---|
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. |
...
Warning |
---|
For access to Hotel Manager, read the chapter Access WebAPI Demo. |
Features currently supported:
- Monitor PBX users and rooms with their realtime status information
- Check-in and check-out
- Block of outgoing calls in case the room status is vacant
- Request to make up the room
- Set up wake up calls
- View call history and call costs
Warning |
---|
Only users of "admin" type can set wake up calls, check-in / check-out and set make-up room status. |
...
Note |
---|
Note: If you are looking for Fias Hotel integration, read documentation: Hotel Integration - FIAS protocol. |
Wallboard
Watch the video tutorial (registration is required)
Warning |
---|
User who needs to access Wallboard should be assigned a Premium license (Interactive Queues are under Premium license). |
...
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:
The counters start once you connect.
- “Calls”: number of calls the agent has managed
- “Global Call Time”: the time this agent has spent in conversations
- “Global Pause Time”: total idle time of this agent
- “Pause Time”: time that has passed since the last call
- “Total calls”: total number of incoming calls to this queue
- “Calls on queue”: number of active calls on this queue
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:
...
connect.
- “Calls”: number of calls the agent has managed
- “Global Call Time”: the time this agent has spent in conversations
- “Global Pause Time”: total idle time of this agent
- “Pause Time”: time that has passed since the last call
- “Total calls”: total number of incoming calls to this queue
- “Calls on queue”: number of active calls on this queue
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:
- Green = available
Light blue = not connected to Collaboration/ 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, 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, 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
...