Twilio API (unofficial showcase)
GET/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json

List available local phone numbers

Lists available local phone numbers in a specified country. Filter results by capabilities, area code, location, or a matching number pattern, and use pagination parameters to browse the results.

23 parameters
AccountSidstringrequired
The SID of the account requesting available phone numbers. Must be `AC` followed by 32 hexadecimal characters.
CountryCodestringrequired
The ISO 3166-1 country code from which to list phone numbers.
AreaCodeintegeroptional
Filter by area code; applies only to phone numbers in the US and Canada.
Containsstringoptional
Match phone numbers using a 2-to-16-character pattern of digits, non-diacritic Latin letters, and supported meta-characters (`*`, `%`, `+`, `$`). Wildcards cannot be adjacent or appear between non-meta-characters; wildcard patterns must include at least two non-meta-characters.
SmsEnabledbooleanoptional
Filter by whether phone numbers can receive SMS messages.
MmsEnabledbooleanoptional
Filter by whether phone numbers can receive MMS messages.
VoiceEnabledbooleanoptional
Filter by whether phone numbers can receive calls.
ExcludeAllAddressRequiredbooleanoptional
Whether to exclude numbers that require an address. Defaults to false when omitted.
ExcludeLocalAddressRequiredbooleanoptional
Whether to exclude numbers that require a local address. Defaults to false when omitted.
ExcludeForeignAddressRequiredbooleanoptional
Whether to exclude numbers that require a foreign address. Defaults to false when omitted.
Betabooleanoptional
Whether to include numbers that are new to the Twilio platform. Defaults to true when omitted.
NearNumberstringoptional
Find a geographically close number to this phone number within the specified distance; applies only to the US and Canada.
NearLatLongstringoptional
Find geographically close numbers to a `lat,long` coordinate pair; applies only to the US and Canada.
Distanceintegeroptional
Search radius in miles for a `near_` query, up to 500 miles. Defaults to 25 miles when omitted.
InPostalCodestringoptional
Limit results to a postal code or, when given a phone number, its postal code; applies only to the US and Canada.
InRegionstringoptional
Limit results to a region, state, or province or, when given a phone number, its region; applies only to the US and Canada.
InRateCenterstringoptional
Limit results to a rate center or, when given a phone number, its rate center; requires `InLata` and applies only to the US and Canada.
InLatastringoptional
Limit results to a local access and transport area or, when given a phone number, its LATA; applies only to the US and Canada.
InLocalitystringoptional
Limit results to a locality or city or, when given a phone number, its locality.
FaxEnabledbooleanoptional
Filter by whether phone numbers can receive faxes.
PageSizeintegeroptional
Number of resources to return per page, from 1 to 1000. Defaults to 50 when omitted.
Pageintegeroptional
Page index used to track pagination state. Must be zero or greater.
PageTokenstringoptional
Page token provided by the API to retrieve a particular page.

1 status code
200Returns a paginated response containing available local phone numbers and their details, including number, location, capabilities, and address requirements.
endintegeroptional
first_page_uristringoptional
next_page_uristringoptional
pageintegeroptional
page_sizeintegeroptional
previous_page_uristringoptional
startintegeroptional
uristringoptional
available_phone_numbersarray<object>optional

Error handling

The AccountSid path parameter must match the account SID format: AC followed by 32 hexadecimal characters, and CountryCode must be an ISO 3166-1 country code. PageSize must be between 1 and 1000, and Page must be zero or greater; Distance can be up to 500 miles. Use Page, PageSize, and PageToken to paginate the results.