Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Phone Numbers

Get All Phone Numbers for System or Reseller

This path will give you all Phonenumbers (DIDs) that are accessable based on the access rights of the Access Token or API Key used to make the requests. Super User or Reseller both supported, but for per domain lookups you should use /domains/{domain}/phonenumbers.

get/phonenumbers

Query parameters

startnumber

This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response.

limitnumber

This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.

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_[*]"
  }
]