{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/phone-numbers/available","auth":"required","params":[{"name":"filters[phone_number]","type":"array_string","default":"","desc":"Phone Number filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.","required":false,"in":"query","ref":"","_id":"5779cadb99b40b0e005abb3d"},{"name":"filters[country_code]","type":"array_string","default":"","desc":"Country Code filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d85"},{"name":"filters[npa]","type":"array_int","default":"","desc":"NANP NPA filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d84"},{"name":"filters[nxx]","type":"array_string","default":"","desc":"NANP NXX filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d83"},{"name":"filters[xxxx]","type":"array_string","default":"","desc":"NANP XXXX filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d82"},{"name":"filters[city]","type":"array_string","default":"","desc":"City filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d81"},{"name":"filters[province]","type":"array_string","default":"","desc":"State or Province (postal code) filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d80"},{"name":"filters[country]","type":"array_string","default":"","desc":"Country (postal code) filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d7f"},{"name":"filters[price]","type":"array_string","default":"","desc":"Price filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d7e"},{"name":"filters[category]","type":"array_string","default":"","desc":"Category filter","required":false,"in":"query","ref":"","_id":"5779cb4d9748b80e00ef3d7d"},{"name":"filters[activation_date]","type":"array_string","default":"","desc":"Activation date (integer timestamp) filter. Available operators: \"eq\", \"gt\", \"lt\", \"gte\", \"lte\"","required":false,"in":"query","ref":"","_id":"5bfec99276f632005c3a6fdd"},{"name":"sort[internal]","type":"string","default":"","desc":"Internal (quasi-random) sorting","required":false,"in":"query","ref":"","_id":"5779cb6a50ffec0e00ca56e4"},{"name":"sort[price]","type":"string","default":"","desc":"Price sorting","required":false,"in":"query","ref":"","_id":"5779cb6a50ffec0e00ca56e3"},{"name":"sort[phone_number]","type":"string","default":"","desc":"Phone Number sorting","required":false,"in":"query","ref":"","_id":"5779cb6a50ffec0e00ca56e2"},{"name":"limit","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"5779cbc199b40b0e005abb41"},{"name":"offset","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"5779cbc199b40b0e005abb40"},{"name":"fields","type":"string","default":"","desc":"Field set","required":false,"in":"query","ref":"","_id":"5779cbc199b40b0e005abb3f"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"filters\": {\n        \"npa\": \"in:201,732\"\n    },\n    \"sort\": {\n        \"phone_number\": \"desc\"\n    },\n    \"total\": 18393,\n    \"offset\": 0,\n    \"limit\": 25,\n    \"items\": [\n        {\n            \"phone_number\": \"+17329976973\",\n            \"formatted\": \"(732) 997-6973\",\n            \"price\": 0,\n            \"is_toll_free\": false,\n            \"country_code\": \"1\",\n            \"npa\": \"732\",\n            \"nxx\": \"997\",\n            \"xxxx\": \"6973\",\n            \"city\": \"Monmouth Junction\",\n            \"province\": \"NJ\",\n            \"country\": \"US\"\n        },\n        {\n            \"phone_number\": \"+17329976972\",\n            \"formatted\": \"(732) 997-6972\",\n            \"price\": 0,\n            \"is_toll_free\": false,\n            \"country_code\": \"1\",\n            \"npa\": \"732\",\n            \"nxx\": \"997\",\n            \"xxxx\": \"6972\",\n            \"city\": \"Monmouth Junction\",\n            \"province\": \"NJ\",\n            \"country\": \"US\"\n        },\n        {\n            \"phone_number\": \"+17329976971\",\n            \"formatted\": \"(732) 997-6971\",\n            \"price\": 0,\n            \"is_toll_free\": false,\n            \"country_code\": \"1\",\n            \"npa\": \"732\",\n            \"nxx\": \"997\",\n            \"xxxx\": \"6971\",\n            \"city\": \"Monmouth Junction\",\n            \"province\": \"NJ\",\n            \"country\": \"US\"\n        }\n    ]\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/phone-numbers/available?filters[npa]=in:201,732&sort[phone_number]=desc\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => \"\",\n    CURLOPT_HTTPHEADER => array(\n        \"authorization: Bearer ThisIsYourAPIAccessToken\",\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n    ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","language":"php"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List Available Phone Numbers","type":"endpoint","slug":"list-available-phone-numbers","excerpt":"","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5779cadb99b40b0e005abb3c","createdAt":"2016-07-04T02:32:59.828Z","editedParams":true,"__v":10,"parentDoc":null,"version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Available Phone Numbers","slug":"available-phone-numbers","order":31,"from_sync":false,"reference":true,"_id":"5779ca1b99b40b0e005abb3a","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","createdAt":"2016-07-04T02:29:47.111Z","__v":0},"editedParams2":true,"githubsync":"","project":"55c8cff571d7580d0063a5e5","user":"55c8cf9471d7580d0063a5e4"}

getList Available Phone Numbers


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

filters[phone_number]:
array of strings
Phone Number filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.
filters[country_code]:
array of strings
Country Code filter
filters[npa]:
array of integers
NANP NPA filter
filters[nxx]:
array of strings
NANP NXX filter
filters[xxxx]:
array of strings
NANP XXXX filter
filters[city]:
array of strings
City filter
filters[province]:
array of strings
State or Province (postal code) filter
filters[country]:
array of strings
Country (postal code) filter
filters[price]:
array of strings
Price filter
filters[category]:
array of strings
Category filter
filters[activation_date]:
array of strings
Activation date (integer timestamp) filter. Available operators: "eq", "gt", "lt", "gte", "lte"
sort[internal]:
string
Internal (quasi-random) sorting
sort[price]:
string
Price sorting
sort[phone_number]:
string
Phone Number sorting
limit:
integer
Max results
offset:
integer
Results to skip
fields:
string
Field set

Examples


Result Format


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 }}