About
Retrieve all details of your numbers with any one of the following requests. Numbers can be configured using our Configure Numbers request or new numbers found with our Purchase Numbers request.
Resource URI
Complete details about your numbers are requested with any one of the following calls. Requests are either for a single number, numbers linked to a property, or numbers associated with an account. The maximum number of numbers returned from a single request is 200.
GET
/v2/Numbers/[Number]
or
/v2/Properties/[PropertySid]/Numbers
or
/v2/Accounts/[AccountSid]/Numbers
Request
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| Number (E.164 Format excluding +) |
string | Retrieve the details of this single number. Exclude + in URLs only. |
| PropertySid | string | Property secure identification to retrieve number details against. |
| AccountSid | string | Account secure identification to retrieve number details against. |
Optional Include Parameters
These resource parameters are to filter lists of numbers if the request made is for property or account numbers.
| Parameter | Type | Description |
|---|---|---|
| Type | string | Comma delimited number types to match any numbers against. May be: Local : Numbers prescribed to a geographical location. Toll-Free : Upon arrival billing numbers. 1800 ect. Shared-Rate : Partial recipient billing numbers. National : Numbers associated nationally for a purpose (E.g. VoIP). |
| Capabilites | string | Comma delimited number capabilities to filter against. May be: Voice : Audio calls. SMS : Text messages. MMS : Multimedia messages. |
| Results_Count | integer | Specify the number of results to return. Default number of results is 200. |
| Results_Skip | integer | Specify a number of records to skip before starting results. This enables custom pagination. |
Response
200 – OK
Our service will respond to every number details request with JSON formatted data. Requests for number details will respond with either a single object or a list of objects containing the following parameters.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| Number (E.164 Format) |
string | The phone number requested. |
| PropertySid | string | The property identification associated with the number. |
| AccountSid | string | Your account identification which is associated with the number and the property. |
| Friendly | string | An assigned friendly name for the number for internal reference. |
| RoutingMethod | string | The current routing method for the phone number. May be: Endpoint : The number will be routed directly to the specified EndpointNumber. |
| EndpointNumber (E.164 Format) |
string | The destination number if the routing method is set to EndpointNumber. |
| Recording | string | The current recording configuration. May be: Off : Calls will not be recorded. Call : All call audio will be recorded. |
| Attribution_Source | string | Calls to this number will be attributed to this source. |
| Attribution_Medium | string | Calls to this number will be attributed to this medium. |
| Attribution_Campaign | string | Calls to this number will be attributed to this campaign. |
| Attribution_Content | string | Calls to this number will be attributed to this content. |
| Type | string | The type of number. May be: Local : The number is prescribed to a geographical location. Toll-Free : An upon arrival billing number. 1800 ect. Shared-Rate : A partial recipient billing number. National : The number is associated nationally for a purpose (E.g. VoIP). |
| Capabilities | string | Comma delimited list of capabilities. May be: Voice : Audio calls. SMS : Text messages. MMS : Multimedia messages. |
| CountryCode | string | Each number as associated with a single country code. E.g AU or US |
| Region | string | The numbers region (if applicable). |
| City | string | The city associated with the number. |
| Status | string | The numbers status. May be: Active : The number is associated with your property and has been registered with an address. Pending : The number has been associated with your property, and is pending successful registration with an address. |
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.