{"_id":"5779cdf4aea88b0e00f63270","project":"55c8cff571d7580d0063a5e5","__v":9,"user":"55c8cf9471d7580d0063a5e4","githubsync":"","version":{"_id":"57624356653c2d2200fec79c","__v":21,"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","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"5779ca1b99b40b0e005abb3a","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-07-04T02:29:47.111Z","from_sync":false,"order":31,"slug":"available-phone-numbers","title":"Available Phone Numbers"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-04T02:46:12.433Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"This service lists phone numbers that are available for purchase through Phone.com.\n\n## Supported Services\n* [List Available Phone Numbers](doc:list-available-phone-numbers)\n\n## Summary Object\nThe Available Phone Number Summary Object is used to briefly represent a phone number. It can be seen in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`phone_number`\",\n    \"0-1\": \"Phone number, in E.164 format\",\n    \"1-0\": \"`formatted`\",\n    \"1-1\": \"Human-readable formatted version of the phone number\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"phone_number\\\": \\\"+15275549813\\\",\\n    \\\"formatted\\\": \\\"(527)  554-9813\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Available Phone Number Object includes the properties in the [Summary Object](#section-summary-object), along with the following:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`price`\",\n    \"0-1\": \"The one-time initial price for this number, in USD. Some numbers show `REQUEST_QUOTE` here.  Please contact our sales department if you are interested in these numbers.\",\n    \"1-0\": \"`is_toll_free`\",\n    \"1-1\": \"Whether the number is toll-free\",\n    \"2-0\": \"`country_code`\",\n    \"2-1\": \"The international dialing prefix for this number. For US and Canadian numbers, for example, this will be \\\"1\\\".\",\n    \"3-0\": \"`npa`\",\n    \"3-1\": \"Area code (a.k.a. NPA).  Included for North American numbers only.\",\n    \"4-0\": \"`nxx`\",\n    \"4-1\": \"Second 3 digits (a.k.a. NXX). Included for North American numbers only.\",\n    \"5-0\": \"`xxxx`\",\n    \"5-1\": \"Last 4 digits (a.k.a. XXXX). Included for North American numbers only.\",\n    \"6-0\": \"`city`\",\n    \"6-1\": \"City with which this number is associated, if known. Otherwise `NULL`.\",\n    \"7-0\": \"`province`\",\n    \"7-1\": \"State or Province with which this number is associated, if known.  Postal Code. Otherwise `NULL`.\",\n    \"8-0\": \"`country`\",\n    \"8-1\": \"Country with which this number is associated, if known. Otherwise `NULL`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"phone_number\\\": \\\"+15742210289\\\",\\n    \\\"formatted\\\": \\\"(574) 221-0289\\\",\\n    \\\"price\\\": 0,\\n    \\\"is_toll_free\\\": false,\\n    \\\"country_code\\\": \\\"1\\\",\\n    \\\"npa\\\": \\\"574\\\",\\n    \\\"nxx\\\": \\\"221\\\",\\n    \\\"xxxx\\\": \\\"0289\\\",\\n    \\\"city\\\": \\\"Nappanee\\\",\\n    \\\"province\\\": \\\"IN\\\",\\n    \\\"country\\\": \\\"US\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Lookup Object\nThe Available Phone Number Lookup Object is used to link to an available phone number from another object. This is used, for example, when [requesting a phone number](doc:create-account-phone-number).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Properties\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`phone_number`\",\n    \"0-1\": \"Phone Number\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nHere is an example. (Yeah, we know it's a bit weird. Phone numbers only have one key that's valid for object lookup, so it's kind of redundant.)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"phone_number: {\\n    \\\"phone_number\\\": \\\"+19993334444\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nInstead of using the object structure shown above, you can also input the phone number alone:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"phone_number: \\\"+19993334444\\\"\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"available-phone-numbers","type":"basic","title":"Available Phone Numbers"}

Available Phone Numbers


This service lists phone numbers that are available for purchase through Phone.com. ## Supported Services * [List Available Phone Numbers](doc:list-available-phone-numbers) ## Summary Object The Available Phone Number Summary Object is used to briefly represent a phone number. It can be seen in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`phone_number`", "0-1": "Phone number, in E.164 format", "1-0": "`formatted`", "1-1": "Human-readable formatted version of the phone number" }, "cols": 2, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"phone_number\": \"+15275549813\",\n \"formatted\": \"(527) 554-9813\n}", "language": "json" } ] } [/block] ## Full Object The Full Available Phone Number Object includes the properties in the [Summary Object](#section-summary-object), along with the following: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`price`", "0-1": "The one-time initial price for this number, in USD. Some numbers show `REQUEST_QUOTE` here. Please contact our sales department if you are interested in these numbers.", "1-0": "`is_toll_free`", "1-1": "Whether the number is toll-free", "2-0": "`country_code`", "2-1": "The international dialing prefix for this number. For US and Canadian numbers, for example, this will be \"1\".", "3-0": "`npa`", "3-1": "Area code (a.k.a. NPA). Included for North American numbers only.", "4-0": "`nxx`", "4-1": "Second 3 digits (a.k.a. NXX). Included for North American numbers only.", "5-0": "`xxxx`", "5-1": "Last 4 digits (a.k.a. XXXX). Included for North American numbers only.", "6-0": "`city`", "6-1": "City with which this number is associated, if known. Otherwise `NULL`.", "7-0": "`province`", "7-1": "State or Province with which this number is associated, if known. Postal Code. Otherwise `NULL`.", "8-0": "`country`", "8-1": "Country with which this number is associated, if known. Otherwise `NULL`." }, "cols": 2, "rows": 9 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"phone_number\": \"+15742210289\",\n \"formatted\": \"(574) 221-0289\",\n \"price\": 0,\n \"is_toll_free\": false,\n \"country_code\": \"1\",\n \"npa\": \"574\",\n \"nxx\": \"221\",\n \"xxxx\": \"0289\",\n \"city\": \"Nappanee\",\n \"province\": \"IN\",\n \"country\": \"US\"\n}", "language": "json" } ] } [/block] ## Lookup Object The Available Phone Number Lookup Object is used to link to an available phone number from another object. This is used, for example, when [requesting a phone number](doc:create-account-phone-number). [block:parameters] { "data": { "h-0": "Properties", "h-1": "Description", "0-0": "`phone_number`", "0-1": "Phone Number" }, "cols": 2, "rows": 1 } [/block] Here is an example. (Yeah, we know it's a bit weird. Phone numbers only have one key that's valid for object lookup, so it's kind of redundant.) [block:code] { "codes": [ { "code": "phone_number: {\n \"phone_number\": \"+19993334444\"\n}", "language": "json" } ] } [/block] Instead of using the object structure shown above, you can also input the phone number alone: [block:code] { "codes": [ { "code": "phone_number: \"+19993334444\"", "language": "json" } ] } [/block]