Add a new dial rule into a dial plan

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

string
required
Body Params
string
enum
required
Defaults to no

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

Allowed:
string
required

This is the main digit string match for the dial translation.

string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
Defaults to *

This is a source match that would allow for a specific dial rule match based on the caller as well as the forward destination of dial-rule-matching-to-uri.

string
Defaults to *

This is a field that will control the DOW (day of week) match for this rule. Default is * or to match all the time, but valid format will allow any single day of the week 0-6 (sunday-saturday) or a range in square brackets like [0-6]

date
Defaults to *

This is the start of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule.

date
Defaults to *

This is the end of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule.

string
Defaults to *

This is the start of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already.

string
Defaults to *

This is the end of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already.

string
enum

This is the application that the call will be routed using. It works in partnership with dial-rule-translation-destination-user and dial-rule-translation-destination-host to forward to a next destination.

string

This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string.

string
enum
Defaults to [*]

This setting controls the "sip schema" on the destination, in most all case setting to "[*]" is correct.

Allowed:
string
required

This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application.

string
Defaults to [*]

This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet.

string
Defaults to [*]

This field will allow customization of the source "name" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [] but you can add a prefix for example with something like this, sales_[]

string
enum
Defaults to [*]

This setting controls the "sip schema" on the destination, in most all case setting to "[*]" is correct.

Allowed:
string
Defaults to [*]

This field will allow customization of the source "user" which is often the caller id number or the value before the @ in then SIP uri. Defaults to [] but you can modify and include [] as the previous value. An example would be using a token like to replace with a user's caller id number.

string
Defaults to [*]

This field will allow customization of the source "host" which is the value after the @ in then SIP uri. Defaults to [] but you can modify and include [] as the previous value. An example would be using a token like to replace with a user's domain

string

This is a description of the number/rule that can be used for defintion or tracking purposes.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json