List Available Phone Number Shared Cost
GET {{twilio_api}}/2010-04-01/Accounts/:AccountSid/AvailablePhoneNumbers/:CountryCode/SharedCost.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":"dolore eu esse","phone_number":"nisi tempor mollit","lata":"laborum Lorem velit d","locality":"adipisicing do l","rate_center":"nostrud","latitude":-43874613.39500294,"longitude":-1553825.715198353,"region":"dolor","postal_code":"labore eiusmod eu ea nisi","iso_country":"in","address_requirements":"consectetur dolore","beta":false,"capabilities":{"mms":false,"sms":true,"voice":false,"fax":false}},{"friendly_name":"pariatur exercitation","phone_number":"occaecat in consect","lata":"minim aliquip","locality":"veniam aute mollit cillum","rate_center":"sunt commodo amet","latitude":-91093274.775583,"longitude":-62001244.10863061,"region":"incididunt consectetur fugiat","postal_code":"est magna enim dolore","iso_country":"Exc","address_requirements":"exercitation in ea in","beta":false,"capabilities":{"mms":true,"sms":false,"voice":false,"fax":true}}],"end":-27083929,"first_page_uri":"http://XB.angjeQmYfBPJzsaLk5sj-h4.UrgyDUHaVws6F51lWA7LICLow0VY4KyHPgs","next_page_uri":"http://Y.kxcM7ab3Z50zyPmNavNI6QrJrzbzLWOnAILsRPzSZmSmp+z8M88H,VcSQfi3mg+uHB3","page":86086676,"page_size":81950684,"previous_page_uri":"http://bPSGbZyEsFQPiQQOmUitYTOHvGO.bjRwGnElzuHXXFZ,79v.-HgDGHSzXiGg6p,L0qrTDaTB0BRxlNz8QIsds24UNWYAV","start":-1148846,"uri":"http://varaGAKJHnuoA.tivbv9fGtKHLs78AnDBw"}