The subresources of the AvailablePhoneNumber
resource lets you search for local, toll-free and mobile 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 certain area code (NPA) or exchange (NXX) or are in a specific geography.
You cannot make requests directly to AvailablePhoneNumber
instance resources. Instead, to find available numbers, make a request to one of the subresources:
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.
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. Each instance of the resource will have the following properties.
beta
type: booleanWhether 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.
subresource_uris
type: object<uri-map>A list of related AvailablePhoneNumber resources identified by their URIs relative to https://api.twilio.com
.
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json
AccountSid
type: SID<AC>The SID of the Account requesting the available phone number Country resource.
^AC[0-9a-fA-F]{32}$
34
34
CountryCode
type: string<iso-country-code>The ISO-3166-1 country code of the country to fetch available phone number information about.
Fetches the subresources available for the US
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json
AccountSid
type: SID<AC>The SID of the Account requesting the available phone number Country resources.
^AC[0-9a-fA-F]{32}$
34
34
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
Gets the subresources available for all supported countries