Read multiple AvailablePhoneNumberTollFree resources

get

https://api.twilio.com/2010-04-01/Accounts/{MAIN_ACCOUNT_SID}/AvailablePhoneNumbers/{CountryCode}/TollFree.json (COPY)

To find any toll-free number

Path Params

MAIN_ACCOUNT_SID

string

required

The SID of the Account requesting the AvailablePhoneNumber resources. Pattern: ^AC[0-9a-fA-F]{32}$ Min length: 34 Max length: 34

CountryCode

string

required

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

Query Params

AreaCode

int32

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

Contains

string

The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

SmsEnabled

boolean

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

MmsEnabled

boolean

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

VoiceEnabled

boolean

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

ExcludeAllAddressRequired

boolean

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

ExcludeLocalAddressRequired

boolean

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

ExcludeForeignAddressRequired

string

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

Beta

boolean

Whether to read phone numbers that are new to the Twilio platform. Can be: true or falseand the default istrue`.

NearNumber

string

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.

NearLatLong

string

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

Distance

int32

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.

InPostalCode

string

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.

InRegion

string

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.

InRateCenter

string

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

InLata

string

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.

InLocality

string

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

FaxEnabled

boolean

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

PageSize

int32

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

Page

int32

The page index. This value is simply for client state. Minimum: 0

PageToken

string

The page token. This is provided by the API.

Responses

200200

404404