{"_id":"57ac1a79d9eb250e00c1a79f","user":"55c8cf9471d7580d0063a5e4","__v":0,"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"},"parentDoc":null,"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"},"project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-11T06:26:01.397Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"This service shows the quantities of phone numbers available for purchase, using region-based grouping.\n\n## Supported Services\n* [List Available Phone Number Regions](doc:list-available-phone-number-regions)\n\n## Region Object\nThe Region Object may include any of several fields describing the group, as well as the quantity of phone numbers available in that group.  Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`country_code`\",\n    \"0-1\": \"Optional. Integer representing the international calling code for the phone number's country.\",\n    \"1-0\": \"`npa`\",\n    \"1-1\": \"Optional. Area Code, for North American phone numbers.\",\n    \"2-0\": \"`nxx`\",\n    \"2-1\": \"Optional. Second set of 3 digits, for North American phone numbers.\",\n    \"3-0\": \"`is_toll_free`\",\n    \"3-1\": \"Optional. Boolean describing whether the phone numbers in this group are toll free.\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"Optional. City name.\",\n    \"5-0\": \"`province_postal_code`\",\n    \"5-1\": \"Optional. Two-letter postal code for the state or province.\",\n    \"6-0\": \"`country_postal_code`\",\n    \"6-1\": \"Optional. Two-letter postal code for the country.\",\n    \"7-0\": \"`quantity`\",\n    \"7-1\": \"Integer. Quantity of phone numbers currently available in the given region.\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\nHere are some examples:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"npa\\\": \\\"402\\\",\\n    \\\"nxx\\\": \\\"289\\\",\\n    \\\"quantity\\\": 14\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"city\\\": \\\"Jacksonville\\\",\\n    \\\"province_postal_code\\\": \\\"FL\\\",\\n    \\\"country_postal_code\\\": \\\"US\\\",\\n    \\\"quantity\\\": 182\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"available-phone-number-regions","type":"basic","title":"Available Phone Number Regions"}

Available Phone Number Regions


This service shows the quantities of phone numbers available for purchase, using region-based grouping. ## Supported Services * [List Available Phone Number Regions](doc:list-available-phone-number-regions) ## Region Object The Region Object may include any of several fields describing the group, as well as the quantity of phone numbers available in that group. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`country_code`", "0-1": "Optional. Integer representing the international calling code for the phone number's country.", "1-0": "`npa`", "1-1": "Optional. Area Code, for North American phone numbers.", "2-0": "`nxx`", "2-1": "Optional. Second set of 3 digits, for North American phone numbers.", "3-0": "`is_toll_free`", "3-1": "Optional. Boolean describing whether the phone numbers in this group are toll free.", "4-0": "`city`", "4-1": "Optional. City name.", "5-0": "`province_postal_code`", "5-1": "Optional. Two-letter postal code for the state or province.", "6-0": "`country_postal_code`", "6-1": "Optional. Two-letter postal code for the country.", "7-0": "`quantity`", "7-1": "Integer. Quantity of phone numbers currently available in the given region." }, "cols": 2, "rows": 8 } [/block] Here are some examples: [block:code] { "codes": [ { "code": "{\n \"npa\": \"402\",\n \"nxx\": \"289\",\n \"quantity\": 14\n}", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"city\": \"Jacksonville\",\n \"province_postal_code\": \"FL\",\n \"country_postal_code\": \"US\",\n \"quantity\": 182\n}", "language": "json" } ] } [/block]