The AvailablePhoneNumber subresources let you search for local, toll-free, and mobile phone numbers available for 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), or are in a specific geography.
You won't be able to make requests directly to AvailablePhoneNumber instance resources. Instead, to find available numbers, request one of the subresources:
- AvailablePhoneNumberLocal resource
- AvailablePhoneNumberTollFree resource
- AvailablePhoneNumberMobile resource
Info
Once you've found a number you'd like to purchase (also referred to as provisioning a number or buying the number), you can do so using the Incoming Phone Numbers API.
Supported Countries and Types
You can query the AvailablePhoneNumber resource to get a list of subresources available for your account by ISO Country. For full information about our phone number support, see our Phone Number CSV or the FAQ.
Response Definitions
Each instance of the resource will have the following items.
| Response Item | Description | Data Types |
|---|---|---|
country_code | The ISO-3166-1 country code of the country. | string |
country | The name of the country. | string |
uri | The URI of the Country resource, relative to https://api.twilio.com. | string |
beta | Whether all phone numbers available in the country are new to the Twilio platform. true if they are and false if all numbers are not in the Twilio Phone Number Beta program. | boolean |
subresource_uris | A list of related AvailablePhoneNumber resources identified by their URIs relative to https://api.twilio | object |