The rule editor in the menus Extensions, IVR, Routines and Inbound is used to create the call flow for an action. A rule can refer to other defined actions for example an IVR or you set the rule values for example when you want link to an echo test.
Each type of rule can be triggered by a condition. Available for selection are:
- Unconditionally → always execute the rule
- Status → when no answer, when busy, when not available, on failure
- Caller-ID → execute rule if source number matches. See conditions using callerid
- Time rule → execute when selected time rule is true.
- Switches → boolean (on/off) function to execute a rule based on the value. For details see menu Switches
ACD
call queue application
link to an already defined Call Queue
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Answer
To let the PBX answer the incoming call. Use when audio must be available before the call is answered manually by a phone. For example, to play music on hold, ACD, IVR, call divert, webhooks.
Wait: number of seconds to wait before continuing. Default 1 second
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Api Events
Incoming call event: → Yes, No
Internal dial event: → Yes, No
Answered event: → Yes, No
Finished event: → Yes, No
Condition: → Unconditionally, Status, Caller-ID, Time rule and Switches
Call a call group
CallGroup: select previously defined call groups
Timeout: seconds to time-out. Default no time-out
Condition → Unconditionally, Status ,Caller-ID, Time rule and Switches
Call an external number
Number: the external number to dial, format in the same way if dialed from a phone
Outbound trunk: force a specific trunk if selected, default value the default trunk
Timeout: seconds to time-out, default no time-out
Inbound CLID handling: Use defaults, keep original, Use DID. Provided your trunk provider allows this the original caller-id of the caller can be displayed on the external phone. Please note that many providers however will not allow you to use a foreign caller-id because they have no way of knowing the caller-id the pbx sends in this scenario is not a scam.
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
IVR – Interactive Voice Response system
link to an already defined IVR
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Conference room
link to an already defined Conference room
Admin mode: enter as admin. Default ‘no’
Announcements: All, Welcome message only, or none (announcements disabled).
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Webhooks
Prompt: custom sound to play
Number of digits: maximum number of digits to accept. 0 = no maximum, or no data input at all if ‘Exact length’ is enabled.
Exact length only: Yes/No if yes then only the specified number of digits will be allowed
Service URL: ‘https’ or ‘http’ URL to remote server
Request method: POST, Get
Request body: request body for POST
Response body regexp: regular expression to match the successful response body
On success: Continue, Extension, IVR
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Echo test
play prompt: play a sound file with explanation
Condition → Condition → Unconditionally, Status Caller-ID, Time rule and Switches
Forward a fax to e-mail
Email: e-mail address of recipient(s)
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Please make sure the SMTP server is set in menu System/Options/Mail SMTP settings!
Hang up the call
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Local extension
list of extensions
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Local voicemail
Play greeting: Play a sound with greeting.
Play instructions: Play a sound with instructions for the caller.
list of voicemail boxes
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Override Outbound CID
Anonymous: Yes, No
New Caller-ID number: disabled when Anonymous is set to ‘Yes’
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Pause Queue Member
ACD: All (default) or select defined queue
Sound: default or select custom sound file
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
PBX user
User: list of defined users
time out: second until ringing times out
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Play a sound file
Sound: list of recorded or imported sound files
Condition → Unconditionally, Status Caller-ID, Time rule and Switches
Play a sound and loop
Sound: list of recorded or imported sound files
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Record call
Upload: Default, Yes, No
Target URL: Allowed values are ‘http’, ‘https’, ‘ftp’, ‘ftps’, ‘sftp’, ‘mailto’ URLs.
Filename: Filename for uploaded files.
Delete after sent: Default, Yes, No
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
See recorded calls for more information.
Record custom sound
Sound name: list of recorded or imported sound files
Maximum sound duration: number of seconds
Maximum silence duration: number of seconds
Keep silence: on/off – removes silence from recording
Play beep: on/off – plays a beep at recording start
Multi-language: on/off enables you to use multiple languages for the same recording
Routine
Routine: list of routines
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Set alert/ring tone
Audio source: internal, PBX sound, Custom URL
Sound or URL: list of available sound when using internal or PBX custom sounds, URL when using custom URL as source
Alert type: external call, internal call, group call or custom (default strings used are ‘alert-external’, ‘alert-internal’, ‘alert-group’).
Info string: when using custom you can set your own text for the Alert type
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Set CID name
look up in phone book: yes – fullname, yes – org. or fullname, no
Fallback name: if no match found in phone book then use this text.
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Set language
Language: list of languages, determines which sound files to play from custom sounds
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Set text prefix
Prefix: free text to show in phone display
Replace: yes/no add or replace any text already set in other rules
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
The Receptionist Console
Timeout: time out in seconds
Room: the receptionist room as defined in menu Services/TRC
Answer and put on hold → Yes, No
Leave TRC room: set when call should leave TRC room and go to the next dialplan rule. The default value is “On timeout only”
On timeout only: when timeout hits then next dialplan rule is executed.
When unavailable or busy: when receptionist phone state is busy or unavailable then next dialplan rule is executed.
When unavailable: when receptionist phone state is unavailable then next dialplan rule is executed.
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Toggle a switch
Switch: list of switches as defined in Services/Switches
State: default state on/off/toggle
On sound: sound to play when choosing on
Off sound: sound to play when choosing off
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Unpause queue member
ACD: All (default) or select defined queue
Sound: default or select custom sound file
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Voicemail Menu
Use caller’s mailbox: when mailbox number prompt should be skipped if the caller may be identified
Skip password prompt: when password prompt should be omitted
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
VoIP Phone
Phone: list of phones as defined in Communication/Phones
Timeout: time out in seconds to go to next line, empty is no timeout
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches
Wait
Interval: time to wait in seconds
Condition → Unconditionally, Status, Caller-ID, Time rule and Switches