Page Comparison

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

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

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

...

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:

...

Introduction 

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

Developer Documentation and JavaScript Library 

Anchor
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: 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: https://webapi.wildix.com/v2/doc/.Developer’s Documentation is available online.

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.

Access WebAPI Demo 

You have several options to access WebAPI demo:

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

Access WebAPI Demo 

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

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://www.wildix.com/webapi/v2/demo/oauth2redirect.html:

...

Click Save to add the application

Copy Application ID, you need for the next step:

Step 2. Login to WebAPI

Enter the following data:

• PBX host
• OAuth Application ID: the one you copy in Step 1
• Click Connect. 

• You are forwarded to oAuth authentication, click Yes to confirm:

...

Recommendations on how to access the new version:

Step 1. Add new OAuth2 application for authentication

• Go to WMS Settings -> PBX -> Integrations
• Select Applications -> OAuth 2.0 tab

• Click Add to create a new application

• Enter Application Name and Redirect URI https://webapi.wildix.com/v2/

...

...

• oauth2redirect.html
  
  

• Image Added

  
  

• Click Save to add the application

• Copy Application ID, you need it for the next step:

  
  Image Added

Step 2. Login to WebAPI

Enter the following data:

• PBX host
• OAuth Application ID: the one you copy in Step 1
• Click Connect

Image Added

• You are forwarded to oAuth authentication, click Yes to confirm:

Image Added

For Hotel Manager, you can use the direct link: https://webapi.wildix.com/v2/wallboardhotelManager/index.html (the news new version)/ hhttps://wwwwebapi.wildix.com/webapiv1/wallboardhotelManager/index.html (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:

...

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:

• 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

...

Image Added

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

Image Added

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: 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 or -1 for WAN port: Image Added 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).

...

...

Hotel Manager

Watch the video tutorial (registration is required):

...

Wallboard

...

Warning
User who needs to access Wallboard should be assigned a Premium license (Interactive Queues are under Premium license).

Full list of supported features: https://www.wildix.com/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.

Example of Wallboard and explanation of counters:

Image Added

 The counters start once you connect.

...

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

Note
Note: After changing any Call group parameters in WMS, the actual change on Wallboard appears with ~10s delay.

...

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

...

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

Note
Note: After changing any Call group parameters in WMS, the actual change on Wallboard appears with ~10s delay.

Macrosuite divider macro

dividerType text dividerWidth 70 emoji {"id":"smile","name":"Smiling Face with Open Mouth and Smiling Eyes","short_names":["smile"],"colons":":smile:","emoticons":["C:","c:",":D",":-D"],"unified":"1f604","skin":null,"native":"😄"} textColor #000000 dividerWeight 2 labelPosition middle textAlignment center iconColor #0052CC fontSize medium text Not finding the help you need? Join the Facebook group to ask a question! emojiEnabled false dividerColor #DFE1E6 dividerIcon bootstrap/CloudsFill

Button macro

buttonText Facebook isButtonShadowOn true emoji {"id":"smile","name":"Smiling Face with Open Mouth and Smiling Eyes","short_names":["smile"],"colons":":smile:","emoticons":["C:","c:",":D",":-D"],"unified":"1f604","skin":null,"native":"😄"} buttonBorderColor #4267b2ff buttonColor #4267b2ff buttonNewTab false buttonFontColor #ffffff buttonSize medium buttonIconColor #ffffff buttonWidthDetection 46 buttonHoverColor #ffffff buttonIcon font-awesome/FacebookSquare buttonType icon_left buttonLink {"link":"https://www.facebook.com/groups/wildixtechwizards","source":"direct"} buttonNewLink buttonRadius 3 buttonShadow 0 id 228 emojiEnabled false buttonWidth 20