/
WebAPI Admin Documentation

WebAPI Admin Documentation

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

Created: April 2018

Updated: November 2025

WMS Version: 6.0X / 7.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:

  1. Add https://webapi.wildix.com/ to PBX whitelist in WMS Settings -> PBX -> Security

  2. Only if you use the new WebAPI version: change Redirect URI to https://webapi.wildix.com/v2/oauth2redirect.html in WMS Settings -> Integrations -> OAuth 2.0 applications

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:

  • https://{PBX_DOMAIN}/public/wtapi.js - the old version

  • https://{PBX_DOMAIN}/public/wtapi.v2.js - the new version

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

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

Both Wallboard and Hotel Manager require a UC-Premium / x-bees SuperBee subscription.

Developer Documentation and JavaScript Library 

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.

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

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:

  • https://{PBX_DOMAIN}/public/wtapi.js - the previous WebAPI version, prior to 5.02.20201015.2

  • https://{PBX_DOMAIN}/public/wtapi.v2.js - the new WebAPI version with oAuth 2.0 authentication, starting from 5.02.20201015.2

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

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

  • PBX host

  • OAuth Application ID: the one you copy in Step 1

  • Click Connect

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

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