The AvailablePhoneNumberLocal resource lets you search for local phone numbers that are available for you to purchase. You can search for phone numbers that match a pattern, are in a certain country, are in a certain area code (NPA) or exchange (NXX) and a variety of other geographic parameters, detailed below.
Info
Once you've found an available number you want to purchase, make an HTTP POST request to the IncomingPhoneNumbers list resource passing the number as the 'PhoneNumber' parameter.
We work hard to keep a wide variety of numbers in stock at all times. See our pricing pages for country availability.
Response Definition
| Response Item | Description | Data Types |
|---|---|---|
friendly_name | A formatted version of the phone number. | string |
phone_number | The phone number in E.164 format, which consists of a + followed by the country code and subscriber number. | string |
lata | The LATA of this phone number. Available for only phone numbers from the US and Canada. | string |
locality | The locality or city of this phone number's location. | string |
rate_center | The rate center of this phone number. Available for only phone numbers from the US and Canada. | string |
latitude | The latitude of this phone number's location. Available for only phone numbers from the US and Canada. | integer |
longitude | The longitude of this phone number's location. Available for only phone numbers from the US and Canada. | integer |
region | The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada. | string |
postal_code | The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada. | string |
iso_country | The ISO country code of this phone number. | string |
address_requirements | The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number's country is required. foreign means an address outside of the phone number's country is required. | string |
beta | Whether the phone number is new to the Twilio platform. Can be: true or false. | boolean |
capabilities | The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false. | object |
capabilities/mms | boolean | |
capabilities/voice | boolean | |
capabilities/sms | boolean | |
capabilities/fax | boolean |