Versions Compared

Key

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



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: April 2018

WMS Version: 3.88

Permalink: https://confluence.wildix.com/x/MwFuAQ


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 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 chapterAccess WebAPI Demo.

...

Option 1 - use our online demo version, available at https://wildix.com/webapi/# 

Option 2 - upload WebAPI to a web server reachable via HTTP/HTTPS 

Option 3 - upload WebAPI on the PBX:

...

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: https://www.wildix.com/webapi/wallboard/ 

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

PBX

Wildix WebAPI online demo locally with .*wildixin.com domain

by adding -2

:

  • Use the link specified above for connection to the online demo version of Wallboard or Hotel Manager
  • Open Settings and in the field Host add -2 to the *.wildixin.com domain name of your PBX for LAN port
and
  • or -1 for WAN
to the domain name.Example:
  • port:


For example, if you add -2 for LAN port -> if the interface has the IP 192.168.0.1 then mypbx-2.wildixin.com

or

will be resolved as 192.168.0.1; if the interface has the IP 10.135.0.1 then mypbx-1.wildixin.com

(where

will be resolved as 10.135.0.1 (in this example mypbx is the *.wildixin.com domain name of

your

the PBX)

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

httpsL

custom secure port https://mypbx.com:433 (or another custom secure port, specified on the page SIP-RTP in WMS)

.

If the PBX is not reachable via FQDN on Windows PC, follow the steps below:

    • Open your Windows start menu, search for the notepad application and then right click the notepad icon
    • Choose Run as administrator and then, while inside notepad, browse to folder C:\Windows\System32\drivers\etc\hosts
    • Add the record: "local_IP FQDN_PBX" Example: 172.16.1.200 myhotelpbx.wildixin.com
    • Save the file


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 a folder /var/www/scripts
  • copy the folder of your application (e.g. Hotel Manager or Wallboard) to /home/admin (delete the version number) using the command scp 
  • move the folder via SSH from /home/admin to /var/www/scripts
  • 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).

...

  • 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
Note

Note: Hotel Manager requires a special Dialplan configuration, find an example here.

...

Note

Note: If you are looking for Fias Hotel integratonintegration, read documentation: Hotel Integration - FIAS protocol

Wallboard

Full list of supported features: https://www.wildix.com/portfolios/call-center-wallboard/  

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

  1. Use the link: www.wildix.com/webapi/wallboard/
  2. Click “Settings” and fill in the fields:

...


...

ExampleExample of Wallboard and explanation of counters:

 The counters start once you connect.

...