List Available Phone Number National
GET {{twilio_api}}/2010-04-01/Accounts/:AccountSid/AvailablePhoneNumbers/:CountryCode/National.json?AreaCode=-88848053&Contains=aliqua dolore &SmsEnabled=true&MmsEnabled=true&VoiceEnabled=true&ExcludeAllAddressRequired=true&ExcludeLocalAddressRequired=true&ExcludeForeignAddressRequired=true&Beta=true&NearNumber=aliqua dolore &NearLatLong=aliqua dolore &Distance=-88848053&InPostalCode=aliqua dolore &InRegion=aliqua dolore &InRateCenter=aliqua dolore &InLata=aliqua dolore &InLocality=aliqua dolore &FaxEnabled=true&PageSize=16
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
AreaCode | number | 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 | boolean | 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 false and the default is true . | |
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 | number | 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 | number | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"available_phone_numbers":[{"friendly_name":"culpa magna","phone_number":"irure","lata":"et","locality":"enim dolore Duis Excepteur","rate_center":"Excepteur amet","latitude":84950309.4607552,"longitude":32189884.951447085,"region":"ut exercitation nulla","postal_code":"mollit voluptate ea amet","iso_country":"qui dolore Lorem cillum","address_requirements":"fugiat velit in quis","beta":true,"capabilities":{"mms":false,"sms":true,"voice":true,"fax":false}},{"friendly_name":"veniam ad","phone_number":"voluptate proident dolor est Lorem","lata":"ea fugiat do","locality":"esse ","rate_center":"laborum tempor","latitude":-17168008.495757684,"longitude":-52028818.75004026,"region":"lab","postal_code":"ipsum tempor","iso_country":"officia do","address_requirements":"eu culpa cupidatat sunt aliquip","beta":true,"capabilities":{"mms":true,"sms":true,"voice":true,"fax":true}}],"end":-12237378,"first_page_uri":"https://qEtOhuAUmnyPtYKJuorxVvHHYIGZEcNW.yzsg04oatTDRYuxQnDXgVAVx5HbvuOKVsTngrvMK0uDRy1DV7","next_page_uri":"https://yufWFoBrGV.wbxV3J9k2toU1Bx2dBRzl","page":83955094,"page_size":11452516,"previous_page_uri":"http://OPFRYXNujyXeffuN.xqlvggvvfAiJrU8gv6XAmQRljMy0KV2XZKqBu95Jc8JeHTT2RaZzIGnxuM5EYCqdmkheCEkYOqTDvKsukDY+S12juh3","start":-83116854,"uri":"http://sRKGXlUKU.ayvWqUo17PsIHq3FrG9JTmwyhsVm43FOdWM0pbgqZnaFLyJeHN7JY63yd-FIsN.Yl3tC5tNTYiD"}