{"__v":1,"_id":"5450c166a66f020800dba820","category":{"__v":5,"_id":"5450b045a66f020800dba73d","pages":["5450b9fb7abbbc0800a5e953","5450c166a66f020800dba820","5450f1397abbbc0800a5eaf6","5450ea98a66f020800dba92e","5450ee92a66f020800dba965"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T09:15:49.477Z","from_sync":false,"order":14,"slug":"incoming-phone-numbers","title":"Incoming Phone Numbers"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"544a586d27b7fc140078db12","version":{"__v":31,"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096","5922fa475c48c70f00f21453","59244fd41e32eb190028ad8d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-29T10:28:54.975Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"first_page_uri\": \"/v2/Accounts/{AccountSid}/IncomingPhoneNumbers.json?Page=0&PageSize=1\",\n    \"end\": 0,\n    \"total\": 18,\n    \"previous_page_uri\": \"\",\n    \"num_pages\": 18,\n    \"incoming_phone_numbers\": [\n        {\n            \"date_updated\": \"Mon, 13 Oct 2014 15:38:43 -0000\",\n            \"voice_url\": \"http://telapi.com/ivr/welcome/call\",\n            \"voice_fallback_method\": \"POST\",\n            \"capabilities\": {\n                \"voice\": \"true\",\n                \"sms\": \"false\"\n            },\n            \"sid\": \"{IncomingPhoneNumberSid}\",\n            \"heartbeat_method\": \"POST\",\n            \"type\": \"local\",\n            \"status_callback_method\": \"POST\",\n            \"voice_fallback_url\": \"\",\n            \"phone_number\": \"{FilteredE164}\",\n            \"hangup_callback\": null,\n            \"hangup_callback_method\": \"POST\",\n            \"heartbeat_url\": null,\n            \"sms_url\": \"http://telapi.com/ivr/welcome/sms\",\n            \"voice_method\": \"POST\",\n            \"voice_caller_id_lookup\": \"false\",\n            \"friendly_name\": \"{FilteredE164}\",\n            \"uri\": \"/v2/Accounts/{AccountSid}/IncomingPhoneNumbers/{IncomingPhoneNumberSid}\",\n            \"sms_fallback_url\": \"\",\n            \"account_sid\": \"{AccountSid}\",\n            \"sms_method\": \"POST\",\n            \"api_version\": \"v2\",\n            \"sms_fallback_method\": \"POST\",\n            \"next_renewal_date\": \"Wed, 12 Nov 2014 15:38:43 -0000\",\n            \"date_created\": \"Mon, 13 Oct 2014 15:38:42 -0000\",\n            \"status_callback\": null\n        }\n    ],\n    \"uri\": \"/v2/Accounts/{AccountSid}/IncomingPhoneNumbers.json\",\n    \"page_size\": 1,\n    \"start\": 0,\n    \"next_page_uri\": \"/v2/Accounts/{AccountSid}/IncomingPhoneNumbers.json?Page=1&PageSize=1\",\n    \"last_page_uri\": \"/v2/Accounts/{AccountSid}/IncomingPhoneNumbers.json?Page=17&PageSize=1\",\n    \"page\": 0\n}\n","language":"json","status":200},{"name":"","code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404}]},"settings":"","try":true,"auth":"required","params":[{"_id":"5450c166a66f020800dba825","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"5450c166a66f020800dba824","ref":"","in":"query","required":false,"desc":"List numbers containing certain digits.","default":"","type":"string","name":"Contains"},{"_id":"5450c166a66f020800dba823","ref":"","in":"query","required":false,"desc":"Specifies that only IncomingPhoneNumber resources matching the input FriendlyName should be returned in the list request.","default":"","type":"string","name":"FriendlyName"},{"_id":"5450c166a66f020800dba822","ref":"","in":"query","required":false,"desc":"Used to return a particular page within the list.","default":"1","type":"string","name":"Page"},{"_id":"5450c166a66f020800dba821","ref":"","in":"query","required":false,"desc":"Used to specify the amount of list items to return per page.","default":"50","type":"string","name":"PageSize"}],"url":"/version/Accounts/AccountSid/IncomingPhoneNumbers.json"},"isReference":false,"order":1,"body":"# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"first_page_uri\",\n    \"0-1\": \"URI for the first page of results.\",\n    \"1-0\": \"end\",\n    \"1-1\": \"Last result index.\",\n    \"2-0\": \"total\",\n    \"2-1\": \"Number of items.\",\n    \"3-0\": \"previous_page_uri\",\n    \"3-1\": \"URI for the previous page of results.\",\n    \"4-0\": \"num_pages\",\n    \"4-1\": \"Number of pages.\",\n    \"5-0\": \"uri\",\n    \"5-1\": \"The Uniform Resource Identifier to this resource.\",\n    \"6-0\": \"page_size\",\n    \"6-1\": \"Number of items on a single page.\",\n    \"7-0\": \"start\",\n    \"7-1\": \"Index of the first item on the current page.\",\n    \"8-0\": \"next_page_uri\",\n    \"8-1\": \"URI for the next page of the results.\",\n    \"9-0\": \"last_page_uri\",\n    \"9-1\": \"URI for the last page of the results.\",\n    \"10-0\": \"page\",\n    \"10-1\": \"Current page number.\",\n    \"11-0\": \"incoming_phone_numbers\",\n    \"11-1\": \"Array containing phone numbers.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\nResponse parameters for incoming phone numbers are equal to those on [\"View Incoming Number\" API call](/v2/docs/view-incoming-number).\n\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/IncomingPhoneNumbers.json' -u 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:39xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\\n\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"shows info on all incoming numbers associated with some account","slug":"list-incoming-numbers","type":"endpoint","title":"List Numbers"}

getList Numbers

shows info on all incoming numbers associated with some account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.

Query Params

Contains:
string
List numbers containing certain digits.
FriendlyName:
string
Specifies that only IncomingPhoneNumber resources matching the input FriendlyName should be returned in the list request.
Page:
string1
Used to return a particular page within the list.
PageSize:
string50
Used to specify the amount of list items to return per page.

Result Format


Documentation

# **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "first_page_uri", "0-1": "URI for the first page of results.", "1-0": "end", "1-1": "Last result index.", "2-0": "total", "2-1": "Number of items.", "3-0": "previous_page_uri", "3-1": "URI for the previous page of results.", "4-0": "num_pages", "4-1": "Number of pages.", "5-0": "uri", "5-1": "The Uniform Resource Identifier to this resource.", "6-0": "page_size", "6-1": "Number of items on a single page.", "7-0": "start", "7-1": "Index of the first item on the current page.", "8-0": "next_page_uri", "8-1": "URI for the next page of the results.", "9-0": "last_page_uri", "9-1": "URI for the last page of the results.", "10-0": "page", "10-1": "Current page number.", "11-0": "incoming_phone_numbers", "11-1": "Array containing phone numbers." }, "cols": 2, "rows": 12 } [/block] Response parameters for incoming phone numbers are equal to those on ["View Incoming Number" API call](/v2/docs/view-incoming-number). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/IncomingPhoneNumbers.json' -u 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:39xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n", "language": "shell" } ] } [/block]