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 guide explains in detail each Dialplan application and provides practical examples and use cases.

Updated: April 2019August 2020

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

Table of Contents


Basic information on how Dialplan works: Dialplan: How does it work?

...

Routes the call to the selected Call Group. Call Groups are set up in Dialplan -> Call Groups (Read the chapter of WMS Start Guide, dedicated to Call groups).

  • Select Call group: select the call group from the list to which the call is routed
  • Message for operator: click the button to access the Sounds menu of the PBX to be able to select or record the message to be played back to the call group member after the call is answered (before connecting to the caller) (this message, for example, can notify an operator present in several call groups, on the type of the call; e.g. one call agent is present both in Tech Support and in Sales group, the message can notify the user that this call is addressed to Tech Support group)
  • Timeout: enter timeout in seconds, in case of no success within the specified timeout, the system proceeds to the next Dialplan application; note that in case you enter no timeout, call will remain in queue forever
  • Music on hold class: select the music on hold to be played to the caller

...

You can enter several extension numbers / email addresses into the field, separated by spaces, in this case the copy of received faxes is sent to multiple destinations:



Read the FAX/ SMS Server Quick Admin Guide for more information on sending and receiving faxes with Wildix Fax Server.

Go to voicemail

Routes the call to the voicemail. 

  • Set Number: modify the called the called number/ email address of  email address of the voicemail destination. You can enter several  extension numbers/ email  email addresses into the field, separated by comma, space  space or semicolon. In this case the voicemail will be sent to multiple destinations
  • Set Options: select  select to Play beep/ Play busy or unavailable message automatically/ Play unavailable message/ Play busy message to the caller


Intercom

 The phone indicated in the “Number” field answers automatically in speaker mode enabling the caller to talk to the user without his/her intervention.

...

Note

Note: if you use web phone, the Intercom Dialplan application is supported only in Chrome web browser.


Note

Starting from WMS 3.86 calls Calls are no longer interrupted by Paging / Intercom including web phone and VoIP phones, starting from 3.88 this behavior is implemented on all devices; a user who is already on the phone, receives Paging / Intercom calls as a normal second incoming call. This behavior can be changed via Dialplan Custom application:

  • SIPAddHeader(Call-Info: sip:wildixgw;answer-after=0;force) - old behavior, enables the phone to answer Paging / Intercom call automatically, even if user is busy on the phone
  • SIPAddHeader(Call-Info: sip:wildixgw;answer-after=5;force) - enables the phone to answer Paging / Intercom call automatically, even if user is busy on the phone after the timeout of five seconds

...

  • Paging group: select the paging group from the list

Note

Starting from WMS 3.86 calls Calls are no longer interrupted by Paging / Intercom including web phone and VoIP phones, starting from 3.88 this behavior is implemented on all devices; a user who is already on the phone, receives Paging / Intercom calls as a normal second incoming call. This behavior can be changed via Dialplan Custom application:

  • SIPAddHeader(Call-Info: sip:wildixgw;answer-after=0;force) - old behavior, enables the phone to answer Paging / Intercom call automatically, even if user is busy on the phone
  • SIPAddHeader(Call-Info: sip:wildixgw;answer-after=5;force) - enables the phone to answer Paging / Intercom call automatically, even if user is busy on the phone after the timeout of five seconds

...

Extends the capabilities of Dial by name / Directory application and allows you to create IVRs with voice control.

...

  • Audio file: click the button to access the Sounds menu of the PBX to be able to select or record the message to be played back to the caller or enter the text to generate using TTS service 
  • Do not answer the call: if enabled,  the Audio file is played without answering the call


Note

How to use TTS in Dialplan:

  • It is necessary to first set the language using “Set” application
  • Available from WMS 3.88: if required, you can change the default voice parameter for TTS message. Add "Set" application and use channel variable "TEXTTOSPEECH_VOICE" indicating the new voice parameter. Supported voices list can be found in WMS -> Sounds (secondary top menu)-> Text-to-speech page. Note, that the language of the voice parameter should match the language selected in "Set" application
  • Write a text using “Play sound” / “Play sound and wait for digits” applications. In case you need to insert a pause between words/ phrases, use a variable <break time="1s"/>, where the value "1s" can be changed to any number of seconds
  • To learn more about variables, read Smart Dialplan Guide - use of Custom Applications
  • You can jump to another Dialplan procedure based on TTS result: use “Jump to if” application with Condition "${TTSSTATUS}"!="SUCCESS" ("UNDEFINED"/"FAILURE")

Note, that this message will not be saved on the PBX and will be generated dynamically upon the execution of this Dialplan application.

Example:

Image RemovedImage Added

Read more about Wildix Business Intelligence (WBI) services: https://confluence.wildix.com/x/3QM8AQ

Warning

Prerequisites:

  • Per User systems (monthly / yearly / five years subscription) (support for Virtual and Hardware PBXs has been added in WMS version 3.88.40314.18  (WMS-4362)
  • Premium license
  • Supported starting from WMS 3.87 (reference ticket WMS-3685)
  • It's necessary to set the language using "Set" application


Play sound and wait for digits

...

  1. Create a new Dialplan procedure “Conference” and edit a Dialplan procedure for incoming calls (“Main” by default) by specifying an office number devoted to conference management as “Called number” (in our example, 04611715109) and adding an operation “Jump to” –> “Conference” procedure:



  2. Edit a Dialplan procedure “Conference”“conference”

An example of configuration for this Dialplan procedure is provided below:

...

  • SRTP security: enable SRTP security for incoming/outgoing/both call directions
  • Direct RTP: “yes” – direct RTP is used for all devices (you can specify the networks in which direct RTP must be used in Settings -> PBX -> Settings SIP-RTP); "no" – direct RTP is turned off for all devices (if not set up via Dialplan, direct RTP is used only for Wildix devices)
  • Codecs: force the usage of selected codec for this type of calls (select codec from the list of supported ones) 

    Note

    Note: you can also manually insert several codecs separated by comma:

    Image Removed

    Image Added


  • Music on hold: select the music on hold from the list
  • Ringtone: select a custom ringtone for a call 
  • Type of call: select the type of call to set for these calls (Internal / External / Whitelist / Blacklist)

...

Case 1: Set custom dial parameters (e.g. “g” – proceed with Dialplan execution at the next priority in the current extension if the destination channel hangs up) - supported starting from WMS 3.87::

  • Insert manually the string DIAL_OPTIONS into the first input field and g (or another option) into the second input field

  • Then add the Dialplan application to which it should be applied, e.g. “Dial the phone”, “Dial the trunk”, “Trunk group”

...

Case 2: Run shell commands or scripts - supported starting from WMS 3.86. For example, you can run data base query command:

...

Case 3: Display a different phone number instead of a real caller / called ID to user in call dialog and CDR - supported starting from WMS 3.86:

For outgoing external calls:

...

  • Add Set -> FORCE_LOOKUP_NUMBER)=XXXXX, (where XXXXX is the number which must be displayed to a user)
  • Then add Look up caller name in phonebook Dialplan application

Case 4: Starting from WMS version 3.87, Display Caller ID is displayed with in Company” field for calls from trunks on Wildix devices:

To make it work: add Diaplan application "Lookup caller name in phonebook", specify in which phonebook to search and in "Set" caller number, tick off "Custom" instead of "Default"

...

Case 5. Disable push notifications for Call group callsStarting from WMS Beta version 3.88.42557.43, it :

It is possible to disable push notifications (mobile and web push) for Call group calls.

...

Case 6  (WMS 4.0X/ WMS 5.0X). Search for a specified parameter of a contact in shared phonebooks in order to route a call to its owner:

  • Add Set  -> insert the function MYVAR=${LOOKUPPHONEBOOK(valuetolookup, fieldswelookup, fieldwewant)}). For example, ${LOOKUPPHONEBOOK(CALLER_NUMBER, 'office, mobile', 'owner_id')}

Example of usage: How to automatically route calls to contact owners.

Case 7 (WMS 5.0X). Enable audio notification (beep) for call intrusion:

When enabled, a beep sound is played when any type of call intrusion (including silent intrusion) is started.

  • Add Set -> INTRUSION_NOTIFICATION -> yes 


DTMF

Generate DTMF

Generates a DTMF tone.

...

Used to execute custom Dialplan applications, not present in the standard list of Dialplan applications, if recommended by Wildix Support Team or on Wildix Forumin Tech Wizards FB group.

Read Smart Dialplan Guide - use of Custom Applications to learn more about the use of custom applications for interaction with external software, MySQL server, PHP, CURL request, TAPI, MySQL Microsoft Database.

...

Example:
Wildix PBXs can interact with external programs via AGI interface. You can create for example, a script that includes a PHP AGI library (already present in the WMS) and execute it via this Dialplan application.

Script example:agiexapmple1Image Removed 


When this script is executed, the system pronounces the number (1234), reproduces the file (in your script use the name of the audio file that exists on your PBX) and then dials the user (340).

...