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>

...

Html
 <div class="lang-box-pdf">
	<div>
		<div class="google-lang">
			<div id="google_translate_element">
			</div>
			<script type="text/javascript">
					function googleTranslateElementInit() {
						new google.translate.TranslateElement({pageLanguage: 'en', includedLanguages: 'de,es,fr,it,nl', autoDisplay: false}, 'google_translate_element');
						}
			</script>
			<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
		</div>
		
		<div class="pdf-button">
			<a href="https://confluence.wildix.com/spaces/flyingpdf/pdfpageexport.action?pageId=23986483" alt="Convert to .pdf" title="Convert to .pdf"><img src="https://confluence.wildix.com/download/attachments/14549012/pdf-button-download-wildix-documentation.png"></a>
		</div>
	</div>
</div>


Info

Please answer three questions to help us improve our Documentation portal: Documentation Feedback


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 2019

WMS Version: 3.88/ 4.0X

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


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).

...

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 

...

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

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:

...

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

For access to Hotel Manager, read the chapter Access WebAPI Demo

Features currently supported:

...

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:

...

User status icons legend:

  • Green = available
  • Blue = not connected to Collaboration/ user not added to roster
  • 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


Note

Here you can find the default template and two additional templates for wallboard: https://drive.google.com/open?id=1HBc5SurA1bVbTveFoNQNM9z4Qgq-HL9P

template queue-users:


template queue-info:


Notes:

  • The templates do not contain the "Settings" file; this means you need to add your host, user, password and call groups directly on the page (uncomment variables in the HTML file)
  • The templates are in Italian; to change the language, edit the corresponding *.widget.js file ("queue-info.widget.js", "queue-users.widget.js")

...