v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-061971481.8 MB
Api20100401Voip

get/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json

Path parameters

AccountSidstring required

The SID of the Account requesting the AvailablePhoneNumber resources.

CountryCodestring iso-country-code required

The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

AreaCodeinteger

The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

Containsstring

Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can't be adjacent to each other.

SmsEnabledboolean

Whether the phone numbers can receive text messages. Can be: true or false.

MmsEnabledboolean

Whether the phone numbers can receive MMS messages. Can be: true or false.

VoiceEnabledboolean

Whether the phone numbers can receive calls. Can be: true or false.

ExcludeAllAddressRequiredboolean

Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

ExcludeLocalAddressRequiredboolean

Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

ExcludeForeignAddressRequiredboolean

Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

Betaboolean

Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.

NearNumberstring phone-number

Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

NearLatLongstring

Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

Distanceinteger

The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

InPostalCodestring

Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

InRegionstring

Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

InRateCenterstring

Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

InLatastring

Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

InLocalitystring

Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

FaxEnabledboolean

Whether the phone numbers can receive faxes. Can be: true or false.

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

endinteger
first_page_uristring uri
next_page_uristring uri nullable
pageinteger
page_sizeinteger
previous_page_uristring uri nullable
startinteger
uristring uri