{"_id":"57acc1fd4472401700faaada","parentDoc":null,"user":"55c8cf9471d7580d0063a5e4","category":{"_id":"57ac170ef1cdae0e0053cdfc","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-08-11T06:11:26.110Z","from_sync":false,"order":31,"slug":"available-phone-number-regions","title":"Available Phone Number Regions"},"__v":5,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-11T18:20:45.232Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"<?php\n\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n\n$response = \n    $client->get('phone-numbers/available/regions?filters[country_postal_code]=US&filters[npa]=858&group_by[]=city');","language":"php"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"group_by\": [\n        \"city\"\n    ],\n    \"filters\": {\n        \"country_postal_code\": \"US\",\n        \"npa\": \"858\"\n    },\n    \"sort\": {\n        \"city\": \"asc\"\n    },\n    \"total\": 10,\n    \"offset\": 0,\n    \"limit\": 25,\n    \"items\": [\n        {\n            \"city\": null,\n            \"quantity\": 33\n        },\n        {\n            \"city\": \"Del Mar\",\n            \"quantity\": 5348\n        },\n        {\n            \"city\": \"La Jolla\",\n            \"quantity\": 1318\n        },\n        {\n            \"city\": \"Linda Vista\",\n            \"quantity\": 207\n        },\n        {\n            \"city\": \"Mira Mesa\",\n            \"quantity\": 687\n        },\n        {\n            \"city\": \"Poway\",\n            \"quantity\": 2091\n        },\n        {\n            \"city\": \"Rancho Bernardo\",\n            \"quantity\": 1151\n        },\n        {\n            \"city\": \"Rancho Penasquitos\",\n            \"quantity\": 2873\n        },\n        {\n            \"city\": \"Rancho Santa Fe\",\n            \"quantity\": 542\n        },\n        {\n            \"city\": \"San Diego\",\n            \"quantity\": 3715\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5779cadb99b40b0e005abb3d","ref":"","in":"query","required":false,"desc":"International calling code filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.","default":"","type":"array_string","name":"filters[country_code]"},{"_id":"5779cb4d9748b80e00ef3d85","ref":"","in":"query","required":false,"desc":"Area Code filter (North America only)","default":"","type":"array_string","name":"filters[npa]"},{"_id":"5779cb4d9748b80e00ef3d83","ref":"","in":"query","required":false,"desc":"2nd set of 3 digits filter (North America only)","default":"","type":"array_string","name":"filters[nxx]"},{"_id":"5779cb4d9748b80e00ef3d82","ref":"","in":"query","required":false,"desc":"Toll-free status filter","default":"","type":"array_string","name":"filters[is_toll_free]"},{"_id":"5779cb4d9748b80e00ef3d81","ref":"","in":"query","required":false,"desc":"City filter","default":"","type":"array_string","name":"filters[city]"},{"_id":"5779cb4d9748b80e00ef3d80","ref":"","in":"query","required":false,"desc":"State or Province filter","default":"","type":"array_string","name":"filters[province_postal_code]"},{"_id":"5779cb4d9748b80e00ef3d7f","ref":"","in":"query","required":false,"desc":"Country filter","default":"","type":"array_string","name":"filters[country_postal_code]"},{"_id":"5779cb4d9748b80e00ef3d7e","ref":"","in":"query","required":false,"desc":"International calling code sorting","default":"","type":"string","name":"sort[country_code]"},{"_id":"5779cb4d9748b80e00ef3d7d","ref":"","in":"query","required":false,"desc":"Area Code sorting (North America only)","default":"","type":"string","name":"sort[npa]"},{"_id":"5779cb6a50ffec0e00ca56e4","ref":"","in":"query","required":false,"desc":"2nd set of 3 digits sorting (North America)","default":"","type":"string","name":"sort[nxx]"},{"_id":"5779cb6a50ffec0e00ca56e3","ref":"","in":"query","required":false,"desc":"Toll Free status sorting","default":"","type":"string","name":"sort[is_toll_free]"},{"_id":"5779cb6a50ffec0e00ca56e2","ref":"","in":"query","required":false,"desc":"City sorting","default":"","type":"string","name":"sort[city]"},{"_id":"57acc3e37ae5c60e004ba3d2","ref":"","in":"query","required":false,"desc":"State or Province sorting","default":"","type":"string","name":"sort[province_postal_code]"},{"_id":"57acc3e37ae5c60e004ba3d1","ref":"","in":"query","required":false,"desc":"Country sorting","default":"","type":"string","name":"sort[country_postal_code]"},{"_id":"5779cbc199b40b0e005abb41","ref":"","in":"query","required":false,"desc":"Max results","default":"","type":"int","name":"limit"},{"_id":"5779cbc199b40b0e005abb40","ref":"","in":"query","required":false,"desc":"Results to skip","default":"","type":"int","name":"offset"},{"_id":"5779cbc199b40b0e005abb3f","ref":"","in":"query","required":false,"desc":"Field set","default":"","type":"string","name":"fields"},{"_id":"57acc3e37ae5c60e004ba3d0","ref":"","in":"query","required":false,"desc":"Fields to group by (supports the same set of fields as the filters and sorting)","default":"","type":"array_string","name":"group_by"}],"url":"/phone-numbers/available/regions"},"isReference":true,"order":1,"body":"This service lists the [quantities of available phone numbers by region](doc:available-phone-number-regions).","excerpt":"","slug":"list-available-phone-number-regions","type":"endpoint","title":"List Available Phone Number Regions"}

getList Available Phone Number Regions


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

filters[country_code]:
array of strings
International calling code filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.
filters[npa]:
array of strings
Area Code filter (North America only)
filters[nxx]:
array of strings
2nd set of 3 digits filter (North America only)
filters[is_toll_free]:
array of strings
Toll-free status filter
filters[city]:
array of strings
City filter
filters[province_postal_code]:
array of strings
State or Province filter
filters[country_postal_code]:
array of strings
Country filter
sort[country_code]:
string
International calling code sorting
sort[npa]:
string
Area Code sorting (North America only)
sort[nxx]:
string
2nd set of 3 digits sorting (North America)
sort[is_toll_free]:
string
Toll Free status sorting
sort[city]:
string
City sorting
sort[province_postal_code]:
string
State or Province sorting
sort[country_postal_code]:
string
Country sorting
limit:
integer
Max results
offset:
integer
Results to skip
fields:
string
Field set
group_by:
array of strings
Fields to group by (supports the same set of fields as the filters and sorting)

Examples


Result Format


Documentation

This service lists the [quantities of available phone numbers by region](doc:available-phone-number-regions).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}