Send Phonenumber to Call Queue

This API will allow updating of an existing number in a domain.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

domain

string

required

Example:

Body Params application/json

phonenumber

string

required

This is the main phonenumber setting. Should be a formated in a e164 format with country count and number. US domestic numbers should be similiar to 18005551234

Example:

18005551234

enabled

enum<string>

optional

Allow a number to be enbaled or disabled.

Allowed values:

yesno

Default:

yes

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-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-description

string

optional

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

Example

{
  "phonenumber": "{{demo_phonenumber}}",
  "responder": "sip:start@call-queuing",
  "to_user": "3000",
  "to_host": "{{domain}}",
  "plan_description": "For Marketing to Queue"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Send Phonenumber to Call Queue

Request

Request samples

Responses