List Available Phone Number Local
GET {{twilio_api}}/2010-04-01/Accounts/:AccountSid/AvailablePhoneNumbers/:CountryCode/Local.json?AreaCode=-88848053&Contains=aliqua dolore &SmsEnabled=false&MmsEnabled=false&VoiceEnabled=false&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":"dolor consequat dolore irure","phone_number":"occaecat","lata":"consequat ullamco","locality":"ut in dolore cupidatat","rate_center":"ut cillum ullamco","latitude":-37080985.571791515,"longitude":81925039.4841794,"region":"aute do amet","postal_code":"magna","iso_country":"voluptate ad ut aute","address_requirements":"dolor","beta":true,"capabilities":{"mms":true,"sms":false,"voice":false,"fax":false}},{"friendly_name":"dolor nisi ex","phone_number":"tempor","lata":"dolor qui","locality":"cillum ullamco commodo Ut reprehenderit","rate_center":"aliquip et exercitation dolore consectetur","latitude":-9412011.01540257,"longitude":30116948.538386136,"region":"esse ullamco velit magna exercitation","postal_code":"dolor magna tempor","iso_country":"ex veniam sunt aliquip anim","address_requirements":"ullamco Excepteur","beta":true,"capabilities":{"mms":true,"sms":true,"voice":false,"fax":false}}],"end":-2239467,"first_page_uri":"http://BggxIzjBpDCxsJXi.lnbxO5gVOO9MKJXPkQBZ","next_page_uri":"https://xcWsYslAhwnKEcaTUu.fkJKpcKJTeSMTFJrRRFC6s56TSbggRPCcBRq.vD+0DFnE2RigBdu","page":-81194716,"page_size":23328463,"previous_page_uri":"http://KDkZjjuRlYVCjLzToZqWnLwZnniX.cliMzj0KL0RWUw9AGotpgOLPXYFrPmmgQLyoA,xHQ9LM+8038Tz","start":-65520854,"uri":"https://jSuePtdf.peGA-zs1N"}