Custom Global Dialplan Variables List

The list of Custom Global Dialplan Variables that allow to change different parameters (WMS -> Dialplan -> General settings -> Set dialplan variables).

Updated: October 2023

Permalink: https://wildix.atlassian.net/wiki/x/5h3OAQ

Custom Global Dialplan Variables

VariableValuesDescription
CALLCOMPLETION=yes (default) / noDisable/ enable CallCompletion feature in pre-answer services
CW_SILENT_RINGTONE=yes (default) / no

Enable / disable silent ringtone for the second incoming call.

If variable set to "no": a second incoming call arrives during an active call, ringtone will be played loudly on the second device registered to the user's account

DEBUG_LUA=all / file

Writes dialplan logs to file /tmp/calls/call-<caller>-<callee>-<date of start call>-<uniqid>.log. Set this value to file or all for activation described logs

DIALBYNAME_PROMPT=custom string

Override a standard prompt when calling via "Dial By Name / Directory" Dialplan application or Feature code "Directory" 82 (ASR only). For example, DIALBYNAME_PROMPT=Please say the first name of the person you wish to call

Note: Starting from WMS 6.04.20231012.1 it is possible to override standard prompt regardless of ASR usage.

DIALNOINSTR=yes / no (default)Disable/ enable message in pre-answer services
DIAL_OPTIONS=stringAdd additional dial options (e.g. “g” – proceed with Dialplan execution at the next priority in the current extension if the destination channel hangs up), take an effect for following Dialplan applications: "Dial the phone", "Dial the trunk" or "Trunk group"
DIALPLANLOGGER_MODE=syslog / file / core (default)

Writes dialplan logs to the following streams:

  • syslog stream (INFO - log level)
  • file with path /tmp/callweaver_call_<timestamp>.log
  • smart technology, that saves active calls to directory /tmp/calls/ and terminated to /tmp/calls/terminated (Required callweaver configuration for logs). This data showed on WMS debug page
DISABLE_FORWARD_NOTIFICATION=yes / no (default)Enable/ disable audio notification in case of call forwarding
DISPLAYINFOUSELOOKUP=yes (default) / noDisable/ enable displaying of caller name and company on incoming call from trunk. It is also possible to display additional info using "Set" Dialplan application. Refer to Dialplan applications Guide , Case 4, for details
EXTCONTACTLOOKUP=yes (default) / noDisable/ enable caller name lookup feature via Worldwide Phonebook for CLASSOUND calls (available in the USA and Canada starting from WMS 6.02.20230201.1)
EXTENDED_DEVSTATE=yes / no (default)Processing device state in case call to/from mobility/office phone (used to enable call waiting, second mobility call)
EXTNUMBERINFO=yes / no (default)Enable/ disable printing to dialplan logs information about the external number, like number type, country, etc
FAXDEBUG=yes / no (default)Enable/ disable debug messages for applications SendFax or ReceiveFax
FAX_HEADER=string headerSet fax header (if not set in user preferences) for fax sending by user
FAX_MACHINE_ID=string IDSet fax machine ID (if not set in user preferences) for fax sending by user
FILTER_183180nosdp=1Resolve no ringback issue with some UK VoIP Operators
Dialplan variable can be also used in Dialplan before “Dial the trunk” application: add “Custom application” and enter into the field: Set(FILTER_183180nosdp=1)
GATTACH_LIMIT=X Set max attachment file size in MB (used for email attachments with mp3 file), e.g., GATTACH_LIMIT=2
GFAXCONGESTION_TRY=X. Default value=30Number of retries of sending fax if no circuit/ channel available
GLOBAL_PHONEBOOK_SEARCH=yes / no (default)

Starting from WMS 5.03. Enable/ disable caller name lookup in Microsoft 365 phonebooks.

For instructions on how to enable Microsoft 365 user phonebook sync, check the guide Import of Contacts and Users - Admin Guide.

HIDE_DTMF=yes (default) / noDisable / enable visualization of DTMFs on WP display
INTRUSION_NOTIFICATION=yes / no (default)Starting from WMS 5.0X. Activate/ deactivate audio notification (beep) for call intrusionA beep sound is played when any type of call intrusion (including silent intrusion) is started.
IVR_ASR=yes (default) / noDisable (return back to entering name via DTMF)/ enable dial by name using ASR for Dialplan application "Dial by name/ Directory"
IVR_ASR_SERVICES=yes (default) / noDisable (return back to entering name via DTMF)/ enable dial by name using ASR for Feature code "Directory"
MinibarType=string(WHOTEL) Set minibar service type (used only for Wildix Hotel Integration with installed whoteld package)
MULTILOGIN_SUPPORT=yes / no (default)Activate / deactivate auto logout of all the WP4X0 phones assigned to one user after performing logout via Feature Code "Login" 99 on a WP4X0
PRIORITIZE_MULTIPLE_QUEUES_LONGEST_WAITING_ANSWER=yes/ no (default)

Starting from WMS 6.02.20230306.1. Enable/ disable possibility to prioritize calls to a user belonging to different call groups by the longest waiting time. 

By default, the feature is disabled. When on, agent receives a call from the queue that has the longest waiting time and next calls are not assigned to another agent until the longest waiting call is answered.

QUEUE_FAST_RECALL=yes/ no (default)Starting from WMS 5.03. The variable overrides the timeout between calls in Call All 10/32 Call group strategy and sends an incoming call to a Call group member as soon as they become available. 

By default, the value is “no” and when a Call group member hangs up, they don't receive an incoming call until the Call group timeout is reached. Check out Call distribution in Call groups - Admin Guide for more details.

RECORDING_EMAIL=emailEmail address to receive a copy of all recordings (file is attached even if related options in General Dialplan settings are disabled)
REPORT_USER_STATUS_FOR_EXT_CALLS=all / status / no (default)

Starting from WMS 5.02. Enable/ disable reporting of user statutes for external calls. Documentation: Wildix Business Intelligence - Artificial Intelligence services.

Values:

  • all - the system reports user status, status message and duration if available
  • status - the system reports only user status
  • no - disables the feature
RETURNFROMTRANSFER=yes (default) / noDisable/ enable Return from Transfer feature (disabled by default for PBXs with "USA" country code except calls returning from parking)
SPLIT_RECORDINGS=yes (default) / no

Starting from WMS 6.03.

Disable/ enable splitting of recordings according to call flows. When enabled, each part of the call has a separate recording. So, if the call was transferred, you can see several recording files when clicking on the recording icon in CDR-View.

It is recommended to keep recording splitting enabled for better compatibility with Cloud Analytics (CRD-View 2.0). 

STEREO_RECORDINGS

Starting from WMS 5.03. Enable/ disable stereo mode.

It is designed for the integration with Feelingstream platform for voice recognition and call recordings in stereo format, to improve the quality of recognition. Check the guide Custom config parameters List.

Note: Quality of call recordings should be set to WAV (WMS -> Dialplan -> General Settings)

Stereo mode can also be used on a PBX independently, without Feelingstream integration.

TEXTTOSPEECH=yes (default) / noDisable/ enable user status reporting via TTS or Dynamic TTS in Dialplan. Documentation: Wildix Business Intelligence - Artificial Intelligence services
TEXTTOSPEECH_TIMEOUT=X seconds. Default value=3

Restrict synthesised waiting time in case TTS service is unavailable


TRANSCRIBE_RECORDED_CALLS=yes / no (default)

Starting from WMS 6.06.20240213.

Enable transcription of the calls that are being recorded. 

Documentation: How to use real-time transcription of x-bees calls and conferences

USER_CAN_PAUSE_RECORDING=yes (default) / noAllow users to pause/ resume a personal recording via FC "Pause recording" *2
USE_USERS_LANGUAGE_FOR_PROMTS=yes / no (default)

Starting from WMS 6.03.

Enable/ disable use of user's language for voice prompts, e.g. when you call a user who is unavailable and you are prompted to leave a voicemail, for incoming calls instead of the trunk’s language

WHotelFamily=string(WHOTEL) Set family and use as an indication of Wildix Hotel Integration with installed whoteld package