Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Phone Numbers

Get All Phone Numbers for Domain

get/domains/{domain}/phonenumbers

Path parameters

domainstring required

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.

Example:example.com

Response

phonenumberstring 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

enabled'yes' | 'no'
domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

dial-rule-application'available-number' | 'to-voicemail-residential' | 'to-callqueue' | 'to-callqueue-announce-count-callers-ahead' | 'to-callqueue-announce-expected-wait-time' | 'to-connection' | 'to-connection-or-user-no-failover' | 'to-single-device' | 'to-user' | 'to-user-residential' | 'to-voicemail' | 'spam-screening' | 'to-connection-block-caller-id' | 'to-connection-no-timeout' | 'to-connection-add-header-force-caller-id' | 'to-connection-add-header-no-timeout' | 'to-connection-add-header' | 'to-single-device-add-header-allow-voicemail' | 'to-single-device-add-header-allow-voicemail-residential' | 'to-single-device-add-header' | 'to-user-add-header' | 'to-user-residential-add-header' | 'to-user-notify-of-recording' | 'hangup' | 'to-user-answer-and-fake-ringback' | 'toggle-timeframe'

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.

dial-rule-parameterstring

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-userstring 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.

dial-rule-translation-destination-hoststring

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.

dial-rule-translation-source-namestring

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_[]

dial-rule-descriptionstring

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

Example response

[
  {
    "phonenumber": "18005551234",
    "domain": "example.com",
    "dial-rule-translation-destination-user": "1000",
    "dial-rule-translation-destination-host": "example.com",
    "dial-rule-translation-source-name": "sales_[*]"
  }
]