REST Client Methods

Available Phone Numbers

View as Markdown

The ability to search for local, toll-free, and mobile phone numbers to purchase.

Properties

friendly_namestringRequired
A formatted version of the number.
phone_numberstringRequired
The number in E.164 format.
latastring or nullRequired
The LATA of the number. Always null.
localitystring or nullRequired

The locality/city of the number. Always null.

rate_centerstring or nullRequired
The rate center of the number. Only available for numbers in US and Canada.
latitudestring or nullRequired
The latitude of the number. Always null.
longitudestring or nullRequired
The longitude of the number. Always null.
regionstring or nullRequired
The state or province abbreviation of the number. Only available for numbers in US and Canada.
postal_codestring or nullRequired

The postal/zip code of the number. Always null.

iso_countrystringRequired
The ISO country code of the number.
capabilitiesobjectRequired
Whether or not a number can receive calls and messages.
betabooleanRequired

Always false. Included for Twilio API compatibility.

Example object

The Available Phone Number Object
1{
2  "friendly_name": "string",
3  "phone_number": "string",
4  "lata": "string",
5  "locality": "string",
6  "rate_center": "string",
7  "latitude": "string",
8  "longitude": "string",
9  "region": "string",
10  "postal_code": "string",
11  "iso_country": "string",
12  "capabilities": {
13    "voice": true,
14    "SMS": true,
15    "MMS": true
16  },
17  "beta": true
18}