Add a new dial rule into a dial plan

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

dialplan

string

required

Body Params application/json

synchronous

enum<string>

write-onlyrequired

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 values:

yesno

Default:

dail-rule-matching-to-uri

string

required

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

Examples:

sip:611@*sip:1??????????@*

enabled

enum<string>

optional

Allowed values:

yesno

Default:

yes

dail-rule-matching-from-uri

string

optional

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 dail-rule-matching-to-uri.

Default:

Examples:

sip:????@**

dial-rule-matching-day-of-week

string

optional

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]

Default:

Examples:

[1-5]1

dial-rule-matching-start-date

string <date>

optional

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.

Default:

Examples:

2023-09-15*

dial-rule-matching-end-date

string <date>

optional

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.

Default:

Examples:

2023-09-16*

dial-rule-matching-start-time

string

optional

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.

Default:

Examples:

02:00*

dial-rule-matching-end-time

string

optional

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.

Default:

Examples:

23:59*

dial-rule-application

enum<string>

optional

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.

Allowed values:

available-numberto-voicemail-residentialto-callqueueto-callqueue-announce-count-callers-aheadto-callqueue-announce-expected-wait-timeto-connectionto-connection-or-user-no-failoverto-single-deviceto-userto-user-residentialto-voicemailspam-screeningto-connection-block-caller-idto-connection-no-timeoutto-connection-add-header-force-caller-idto-connection-add-header-no-timeoutto-connection-add-headerto-single-device-add-header-allow-voicemailto-single-device-add-header-allow-voicemail-residentialto-single-device-add-headerto-user-add-headerto-user-residential-add-headerto-user-notify-of-recordinghangupto-user-answer-and-fake-ringbacktoggle-timeframe

dial-rule-parameter

string

optional

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

dial-rule-translation-destination-scheme

enum<string>

optional

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

Allowed values:

[*]sip:<Null>

Default:

[*]

dial-rule-translation-destination-user

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.

Examples:

1000250018005551234

dial-rule-translation-destination-host

string

optional

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.

Default:

[*]

Examples:

example.com<OwnDomain>

dial-rule-translation-source-name

string

optional

This field will allow customization of the source "name" often used for teh 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_[]

Default:

[*]

Examples:

sales_[*][*]<OwnCidName>

dial-rule-translation-source-scheme

enum<string>

optional

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

Allowed values:

[*]sip:<Null>

Default:

[*]

dial-rule-translation-source-user

string

optional

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.

Default:

[*]

Examples:

<OwnCidNmbr>[*]

dial-rule-translation-source-host

string

optional

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

Default:

[*]

Examples:

<OwnDomain>[*]

dial-rule-description

string

optional

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

Example

{
  "synchronous": "yes",
  "dail-rule-matching-to-uri": "sip:611@*",
  "dail-rule-matching-from-uri": "*",
  "enabled": "yes",
  "dial-rule-translation-source-name": "611 - [*]",
  "dial-rule-translation-source-user": "[*]",
  "dial-rule-translation-source-host": "[*]",
  "dial-rule-application": "to-callqueue",
  "dial-rule-translation-destination-user": "{{queue}}",
  "dial-rule-translation-destination-host": "{{domain}}",
  "dial-rule-description": "611 - Customer Service Direct Dial"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add a new dial rule into a dial plan

Request

Request samples

Responses