Admin level documentation contains technical notes for PBX administrator and explains how to set up and configure different Wildix services and features.

PBX

Notify users of call recording

Feature is used to inform callers that their call is going to be recorded from now on and give the ID of the file at the end of the recording. This feature supports custom audio notifications upon call recording is enabled / disabled.

How-to:

  • Create new dialplan procedure and name it “record_notify”
  • Add called numbers “start” and “stop”, where start is used to notify caller when call recording is activated, “stop” is used to notify caller when call recording is deactivated
  • LIMITATION: only Custom Applications can be used

Example[“record_notify”] = { [“start”] = {Playback(“< Some notification about recording >”);}[“stop”] = {Answer();Wait(2);SayDigits(${RECID}); //Play unique id of the RecordHangup();}}

Execute script after receiving an SMS

Proceed as follows:

  • Access PBX via SSH
  • Copy template from /usr/local/share/scripts/ to working directory /usr/local/bin and rename file:cp /usr/local/share/scripts/smsdrxcb.sh.sample /usr/local/bin/smsdrxcb.sh
  • Set result file as executable:chmod a+x /usr/local/bin/smsdrxcb.sh
  • Fill script by user actions

WMS network Server replacement

Proceed as follows:

  • Move all users from Client PBX (future Server)
  • Disable wms-network on this Client
  • Delete this Client from PBXs page on Server
  • Make a backup on Server
  • Apply this backup on Client

Generate certificate for SIP-RTP page

Generate certificate on LINUX system:

  1. openssl genrsa -des3 -out server.key 2048
  2. openssl rsa -in server.key -out server.key
  3. openssl req -sha256 -new -key server.key -out server.csr -subj “/C=IT/ST=TN/L=My City/O=My Company/CN=examplecompany.com” (use your country instead of IT (Italy) and your region instead of TN (Trento))
  4. openssl x509 -req -sha256 -days 3650 -in server.csr -signkey server.key -out server.crt

Output:server.crt server.csr server.key

Upload server.crt and server.key to WMS Settings > PBX > SIP-RTP page.

Dialplan

Skip “callgroup” application if call group is empty or members are busy

Add the following custom application before “Call group” Dialplan application:

GotoIf($[ ${QUEUE_MEMBER(2,ready)} == 0 ])?main,100,1)

where

– 2 : is ID of your call group;

– main,100 : dialplan and match, where you define what todo if group is not ready

If group ID 2 has no members ready to answer the call, system will jump to procedure “main”, at extension “100” and priority “1”. There you can define what to do in this case.

WebRTC Kite and ubiconf videoconference

How audio and video streams are managed?

WebRTC Kite 1 to 1

Chat messages, presence, screen sharing and call signalling are transmitted through Kite mediator

Audio and video flows go directly from the browser to the PBX

Video conference

All audio and video streams from / to the participants to the Video conferencing system are mixed and sent as one stream. That is, to save the bandwidth, participants can disable their videos.

Collaboration

Ensure QoS

It’s possible to force QoS settings for WebRTC phone (see Ensure QoS).

How much bandwidth is necessary for calls?

For calls via Collaboration using G.711 codec 80 Kbps is necessary.

For via ubiconf videoconference, check documentation.

Two-Factor Authentication

Notes:

  • available for Google Authenticator, Free OTP, Microsoft Authenticator or any other TOTP auth app
  • available for Collaboration / WMS
  • one-time password is valid for 90 seconds
  • time on user device and on PBX should be synced according to time zones
  • 2FA can be used for AD authentication
  • 2FA can be enabled in user personal settings in Collaboration

Limitations:

  • WebAPI does not work if 2FA is enabled for user
  • Integration Utility (TAPI driver) does not work if 2FA is enabled for user
  • 2FA is not available for iOS / Android / WP600A apps
  • login with 2FA is not available for Google / Office 365 single sign-on (it is supposed that user who doesn’t know his/her WMS password can use Google / Office 365 password)
  • user can log in to a different PBX in WMS Network without 2FA even if 2FA is enabled

Note: Google Authenticator / Free OTP apps doesn’t provide access pin, secret keys backup, sync or migration between devices, if you need such features, use other apps (e.g. Authy)

Set up Popup URL / App

Popup URL / App allows you to open an application or a web page upon receiving or placing a call and pass parameters (static parameters or supported variables).

You can set up the popup URL / App to be for incoming / outgoing call and to select the triggering event:

  • On-click: click the link to open the app / URL

  • Ringing: the app / URL opens upon receiving / placing a call (when call is in “ringing” state)
  • Answer: the app / URL opens as soon as the call is answered

Supported variables

Click on the question mark “?” to view the prompt:

Examples: http://yourhost.com/variable1={param} -> example with popup URL

“C:\Program Files\Internet Explorer\iexplore.exe” http://yourhost.com/?var1={param}^&var2={param} -> example with application

Supported variables {param}:

{CALLERNUM} – Caller number

{CALLERNAME} – Caller name

{USERNUM} – User number

{USERNAME} – User name

{CALLTYPE} – Call Type (incoming / outgoing)

{TAGS} – Call tags

Variable manipulation:{CALLERNUM:1} – removes the first digit -> in this way you can remove the first digit from the caller number

Popup URL example

You can enter one or several parameters which can be passed to the specified URL, example:

Example: when you receive an incoming call, the application opens the web page where the new ticket is created, fields “To”, “Subject”, “From number” are filled out automatically, where “To” and “Subject” are the static parameters entered by you and “From number” is the phone number variable entered automatically:

http://www.yourhost.com/index.pl?Action=AgentTicketPhone&Subaction=StoreNew&To={CALLERNAME}&Subject=New%20Ticket%20from%20{USERNAME}&From={CALLERNUM}

Where

  • http://www.yourhost.com/index.pl?Action=AgentTicketPhone&Subaction=StoreNew – is the link to create a new ticket in your web application
  • To={CALLERNAME}& – is the caller name which is filled into the field “To”
  • Subject=New%20Ticket%20from%20{USERNAME} – here “New%20Ticket%20from%20” is the static parameter entered into the field “Subject”, {USERNAME} – is variable, for example if user name is John Doe, subject is “New Ticket from John Doe”
  • From={CALLERNUM} – is the caller number which is filled into the field “From”

Popup App examples

For Windows it is necessary to indicate a complete path to the executable file, and to use the special character “^” before “&”, example:

“C:\Program Files\Internet Explorer\iexplore.exe” http://www.yourhost.com/index.pl?Action=AgentTicketPhone^&Subaction=StoreNew^&To={CALLERNAME}^&Subject=New%20Ticket%20from%20{USERNAME}^&From={CALLERNUM}

One more example:

iexplorer.exe “http://yourhost.com/param1=value1&param2=value2&variable1={CALLERNUM}”

Where

  • param1 and param2 are the names of your parameters (e.g. Name, Department),
  • value1 and value2 are the values for those parameters (e.g. your name – John Doe or variable {USERNAME} and your department – Support)
  • variable1 is the number
  • <<clid>> variable displays the actual caller / called number

iexplorer.exe “http://yourhost.com/Name={USERNAME}&Department=Support&Number={CALLERNUM}”

Display incoming video from video intercom stream before answer

Same as for WP600AXX: Display incoming video from video intercom stream before answer

Devices

Ensure QoS

To set DSCP QoS for all the Wildix devices:

  • Set DSCP value at af41 or higher in WMS Settings -> PBX -> SIP-RTP
  • Configure all the routers / firewalls to prioritize such traffic

It is possible to enable / disable DSCP QoS for WebRTC phone *(Collaboration on Chrome) and ubiconf conference in Collaboration Settings -> Web Phone -> DSCP QoS:

  • Default: If DSCP value is set to af41 or higher in WMS Settings -> PBX -> SIP-RTP, then DSCP is enabled by default
  • On / Off: Force DSCP on or off, independently from the settings on SIP-RTP page

*starting from WMS 3.86

Occasionally routers / firewalls / operators can block traffic with DSCP settings different from 0, in such case:

  • Administrator must disable globally DSCP QoS in WMS Settings -> PBX -> SIP-RTP
  • User can disable QoS separately for WebRTC Phone (Web Phone on Chrome) in Collaboration Settings -> Web Phone

Enable syslog

To enable syslog, proceed as follows:

  • Go to WMS -> Devices
  • Select device and click Edit device
  • Enable the option “Syslog server” and enter the domain name or the IP address of the PBX (appears by default once you enable the option)
  • Select the device and click Configure / Sync device

You can install a syslog server on your Windows PC, for example, a Kiwi syslog server (free version allows collecting logs from up to 5 devices). In this case, you need to enter the IP address of your Windows PC into the field “Syslog server”.

Manual update of W04FXS/W04FXO from FW version 3.08 / 3.09

In some cases W04FXO / W04FXS could become unreachable after firmware upgrade from the version 3.08 or 3.09. To avoid this problem, please follow the procedure of manual upgrade via the web interface of the gateway, as described in this post

  1. Download the *.bin file from the folder: LINK
  2. Connect to the web interface of the FXO gateway using admin : admin credentials for new devices or admin : [WMS_random_password] for provisioned devices.
  3. Open the page [device_IP_address]/FirmUpgrade.asp (add /FirmUpgrade.asp into the browser URL bar after your gateway’s IP address)

Example: 10.135.0.100/FirmUpgrade.asp

Where “10.135.0.100” is your gateway’s IP address

  1. Upload the file with the new FW via the web interface of the gateway (Choose the file and click “Import”):

  1. In case the upload has been successful, you get the following notification:

Do not reboot the gateway manually! Wait till the notification appears and then proceed to the next step.

  1. Go to the page [device_IP_address]/Maintenance.asp

(edit the browser URL bar by adding /Maintenance.asp after your gateway’s IP address)

Example of the browser URL bar: 10.135.0.100/Maintenance.asp

  1. Select “Reboot” and click “Apply”:

Call control using R / Flash button on W24FXS 2015

(starting from FW version 27.18.01.16)

In case of the second incoming call during an active call:

  • press R to put the active call on hold and to answer the second incoming call
  • press R+1 to end the active call and to answer the second incoming call

In case you have one active call and one call on hold:

  • press R to swap the calls (or R+2)
  • press R+1 to end the active call and to resume the call on hold

W-AIR

W-AIR Multicell network over a Network of PBXs with auto roaming

More information on this feature: BLOG

Requirements:

  • layer 3 VPN over all sites
  • support for UDP fragmentation (since MTU of packets is over 1500 bytes)
  • base stations must be able to reach each other via IP

How-to:

  1. Enter the local IP address of the Primary Base Station into the field “Primary Base IP” (Devices -> W-AIR Networks -> “Edit Network”)
  2. Connect all the base stations and add them to the WMS Network Server PBX
  3. Set as DNS server for each base station (in Devices -> “Edit” device) the PBX to which the base station must be connected
  4. Set as DNS name “auto.wildixin.com” in the field “SIP Proxy” (Devices -> W-AIR Networks -> “Edit” Network) to have all phones connected to the correct PBX (this is possible thanks to point 3)

Delete a handset IPEI from W-AIR SB

To delete a handset and reuse the slot, proceed as follows:

  • Open W-AIR SB web interface -> Extensions and select the handset you want to remove (click on the IPEI value):

  • The Handset menu opens; enter the value “FFFFFFFFFF” into the field “IPEI” and click Save:

  • Register a new handset to the W-AIR base station: on the handset open the menu Connectivity -> Register; after the new handset is registered, it appears on the W-AIR SB web interface, in the menu Extensions
  • Access the PBX via SSH and add PBX parameter “ResetHandset=yes” to the [wildixair] section of the /rw2/etc/provision.conf[wildixair]ResetHandset=yes
  • Perform logout procedure: dial 99 from the handset and follow the prompts
  • Remove PBX parameter “ResetHandset=yes” from the [wildixair] section of the /rw2/etc/provision.conf[wildixair]

WP600AXX

First time use of Chrome on WP600AXX

Note: this note applies to newly ordered phones, Android firmware v. 47.145.7.438 and later

  1. The first time you start Chrome on WP600AXX, there appears the message “Welcome to Chrome”: Tap “ACCEPT & CONTINUE”

Screen Shot 2017-06-30 at 11.24.30

  1. You get the notification inviting you to update Google Play services.

IMPORTANT: do not tap “Update”, instead tap somewhere on the screen:

Screen Shot 2017-06-30 at 11.18.44

  1. The next message invites you to Sign in to Chrome: tap “NO, THANKS”

Screen Shot 2017-06-30 at 11.21.44

Now you can start using Chrome browser on your WP600AXX:

ch4

Log in multiple phones at a time

It is possible to use the password of “admin” user for fast auto-configuration of multiple WP600A/WP600ACG phones in LAN.

Go to Phone App Settings > Account

  • Domain: Enter the PBX domain name or IP address
  • User name: Enter the user’s extension number / user name / user’s email address
  • Password: Enter the password of “admin” user of the PBX

During provisioning the user password is communicated to the phone and the next time user can perform log in using his/her own password.

Disable auto-updates

Updates notes and changelog: LINK

Phone App > Settings > Advanced:

auto upgrades = ON New Android FW is installed during the night, no confirmation is needed; Phone App / WildixDAV are automatically downloaded but need your confirmation to be installed

auto-upgrades = OFFnotify of new versions = ON Only notification about new version (Android FW / Phone APP/ WildixDAV) is displayed, new version is not installed automatically

auto-upgrades = OFFnotify of new versions = OFFNo auto-upgrade and no notification about new versions

Change Number of BLF keys per page

Phone App > Settings > Advanced:

4 keys per page

Supported in case 12 or less keys are configured: 3 pages x 4 keys)

18 keys per page

Supported in case 54 or less keys are configured: 3 pages x 18 keys

40 keys per page

Default: 3 pages x 40 keys

WebRTC ubconf conference on WP600AXX

Q: Can I create a conference from the phone?

A: No, you must be invited by PBX user, you receive an invitation by chat and you must open the invitation link in Chrome browser to participate in the conference

Q: In case of incoming call, the conference is interrupted

A: Enable the option “Allow usage of other VoIP apps” in Phone App > Settings > Advanced

Phonebooks on WP600AXX

Q: Do I need an external application to sync contacts?

A: No, sync with PBX phonebooks is enabled automatically. Go to Dialpad and start typing a name or a number to start a live search. First colleagues are displayed, then phonebooks contacts.

WP600AXX phone recovery

  1. if your phone is on, turn it off
  2. press and hold the “Headset” button and turn on power (using power adapter or PoE)
  3. release “Headset” button after 5 seconds
  4. the image “W” appears on the display and then the recovery menu
  5. press “2″ button to select “Factory reset” and “Headset” button to start the reset
  6. after reset procedure, update Phone app to the latest version

Door open function

You can add an unlock button allowing you to open the door from the call management window.

Add Dialplan Custom Application: SIPAddHeader(Unlock-Button:*1234#), where “1234″ is DTMF

unlock-button.png

Display incoming video from video intercom stream before answer

Add Dialplan Custom Application SIPAddHeader(Camera:http://admin:admin@192.168.1.100/picture0.jpg)

where:

  • admin:admin – username and password, if needed
  • 192.168.1.100 – IP address of intercom / camera
  • /picture0.jpg – picture URL (only .*jpg format is supported at the moment)

More examples:

  • SIPAddHeader(Camera:http://www.testcam.local/camera/image.jpg)
  • SIPAddHeader(Camera:http://admin:admin1@10.100.4.44/snapshot/view0.jpg)
  • SIPAddHeader(Camera:http://admin:meinsm@10.100.4.113/record/current.jpg?sync=-99)
  • SIPAddHeader(Camera:https://admin:mypassword@10.100.4.111/api/camera/snapshot?width=1280&height=960&fps=15) (2N example)

Note: this custom application can be used in two scenarios: 1) call a doorphone and see the video stream 2) see video stream from the doorphone before answer

In case you don’t know how to indicate the path correctly for your IP webcam / intercom, check this resource: LINK (mind that only HTTP connection and JPEG type are supported)

iOS / Android

Check / remove push notification subscription

Check push notifications subscription

To check if push (Web push / iOS / Android push) are enabled for an extension: access via SSH as root and launch the following command

kamcmd htable.dump mobile_devices_data | grep EXT
where EXT = extension of user

Remove push notifications subscription

Script: push_remove

Arguments:push_remove -h -> display help
push_remove -list -> display list of extensions that subscribed to push notifications
push_remove 315 -> remove push notifications for extension 315
push_remove 315 316 317 -> remove push notifications for extensions 315, 316 and 317

Disable push notifications

To disable push notifications and disconnect from VoIP and Presence server, open the app and set user status to “offline”. Otherwise, log out from the app.

Call history is empty inside the Wildix mobile app

Make sure that:

  • backend for CDR is enabled in WMS Settings > PBX > CDR
  • ACL group of your user does not have restriction “cannot use” -> “history”

App won’t load or No calls in idle on Android

Problem (ANDROID): you stop receiving incoming calls and chats some time after the app goes in the background modeOR: you open the app but it won’t load

This happens due to the “Battery optimization” feature of Android: the system prevents idle applications from consuming the battery. Once the application goes to sleep mode, you no longer receive calls and chats.

Solution: add Wildix app to the list of exceptions for “Battery optimization”, or in other words, disable doze mode for Wildix app.

How-to: go to Settings -> tap “Battery” -> tap “Battery optimization” option from the top-right menu icon > select “All apps” from the options -> select Wildix app -> tap “Don’t optimize” => DONEandroid 7

android 7

No push notifications on Android

Check ports to open for different Wildix services: document.

On some devices push notifications are blocked by default, it’s necessary to manually allow push notifications for:HUAWEI: Settings->Protected Apps, enable the option for Collaboration and restart the appXIAOMI: Security->Autostart, enable the option for Collaboration and restart the app

Use of iOS / Android app outside the office network

Use of App outside the office network: the first time you make a login from the local network, the PBX sends the settings of the public network to the application (the same for connection from the public IP). The app then tries to connect using the first IP and if fails, it moves to the second one, thus ensuring the connection both when you are in or outside the office.