{"__v":1,"_id":"5450b9fb7abbbc0800a5e953","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-29T09:57:15.709Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\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\": \":IncomingNumberSid\",\n    \"heartbeat_method\": \"POST\",\n    \"type\": \"local\",\n    \"status_callback_method\": \"POST\",\n    \"voice_fallback_url\": \"\",\n    \"phone_number\": \":filtered_e164_address\",\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\": \":filtered_e164_address\",\n    \"uri\": \"/v2/Accounts/:AccountSid/IncomingPhoneNumbers/:IncomingNumberSid\",\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","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":"5450b9fb7abbbc0800a5e955","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"5450b9fb7abbbc0800a5e954","ref":"","in":"path","required":true,"desc":"Incoming number SID.","default":"","type":"string","name":"IncomingNumberSid"}],"url":"/v2/Accounts/AccountSid/IncomingPhoneNumbers/IncomingNumberSid"},"isReference":false,"order":0,"body":"TelAPI phone numbers associated with an account are represented with the IncomingPhoneNumbers resource.\n\n# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"An alphanumeric string identifying this resource.\",\n    \"0-0\": \"sid\",\n    \"1-0\": \"friendly_name\",\n    \"1-1\": \"User generated name for the incoming number.\",\n    \"2-0\": \"account_sid\",\n    \"2-1\": \"An alphanumeric string identifying the account this phone number is registered with.\",\n    \"3-0\": \"type\",\n    \"3-1\": \"The type of TelAPI number (local, international, etc.).\",\n    \"4-0\": \"voice_url\",\n    \"4-1\": \"The URL returning InboundXML incoming calls should execute when connected.\",\n    \"5-0\": \"voice_method\",\n    \"5-1\": \"Specifies the HTTP method (GET or POST) used to request the VoiceUrl once incoming call connects.\",\n    \"6-0\": \"voice_fallback_url\",\n    \"6-1\": \"URL used if any errors occur during execution of InboundXML on a call or at initial request of the VoiceUrl.\",\n    \"7-0\": \"voice_fallback_method\",\n    \"7-1\": \"Specifies the HTTP method (GET or POST) used to request the VoiceFallBackUrl if it is needed.\",\n    \"8-0\": \"voice_caller_id_lookup\",\n    \"8-1\": \"Specifies if the incoming number has voice caller ID lookup enabled.\",\n    \"9-0\": \"date_created\",\n    \"9-1\": \"The date the incoming phone number resource was created.\",\n    \"10-0\": \"date_updated\",\n    \"10-1\": \"The date the incoming phone number resource was last updated.\",\n    \"11-0\": \"sms_url\",\n    \"11-1\": \"The URL returning InboundXML incoming phone numbers should execute when receiving an sms.\",\n    \"12-0\": \"sms_method\",\n    \"12-1\": \"The HTTP method used when making requests to the SmsUrl. Either GET or POST.\",\n    \"13-0\": \"sms_fallback_url\",\n    \"13-1\": \"URL used if any errors occur during execution of InboundXML from an sms or at initial request of the SmsUrl.\",\n    \"14-0\": \"sms_fallback_method\",\n    \"14-1\": \"Specifies the HTTP method (GET or POST) used to request the SmsFallbackUrl.\",\n    \"15-0\": \"heartbeat_url\",\n    \"15-1\": \"URL that can be used to monitor the phone number.\",\n    \"16-0\": \"heartbeat_method\",\n    \"16-1\": \"The HTTP method TelAPI will use when requesting the HeartbeatURL. Either GET or POST.\",\n    \"17-0\": \"capabilities\",\n    \"17-1\": \"The features available with this incoming phone number. The Elements voice and sms are nested within this property with their values as either True or False depending on what the number is capable of.\",\n    \"18-0\": \"status_callback\",\n    \"18-1\": \"URL that can be requested to receive notification when and how incoming call has ended.\",\n    \"19-0\": \"status_callback_method\",\n    \"19-1\": \"Specifies the HTTP method (GET or POST) used to request the HangupCallback URL.\",\n    \"20-0\": \"hangup_callback\",\n    \"20-1\": \"This is a StatusCallback clone that will be phased out in future versions.\",\n    \"21-0\": \"hangup_callback_method\",\n    \"21-1\": \"This is a StatusCallbackMethod clone that will be phased out in future versions.\",\n    \"22-0\": \"api_version\",\n    \"22-1\": \"The API version used with this incoming number.\",\n    \"23-0\": \"uri\",\n    \"23-1\": \"The Uniform Resource Identifier to this resource.\"\n  },\n  \"cols\": 2,\n  \"rows\": 24\n}\n[/block]\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/IncomingPhoneNumbers/DIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -u 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:39xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"shows info on an incoming phone number","slug":"view-incoming-number","type":"endpoint","title":"View Number"}

getView Number

shows info on an incoming phone number

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.
IncomingNumberSid:
required
string
Incoming number SID.

Result Format


Documentation

TelAPI phone numbers associated with an account are represented with the IncomingPhoneNumbers resource. # **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-1": "An alphanumeric string identifying this resource.", "0-0": "sid", "1-0": "friendly_name", "1-1": "User generated name for the incoming number.", "2-0": "account_sid", "2-1": "An alphanumeric string identifying the account this phone number is registered with.", "3-0": "type", "3-1": "The type of TelAPI number (local, international, etc.).", "4-0": "voice_url", "4-1": "The URL returning InboundXML incoming calls should execute when connected.", "5-0": "voice_method", "5-1": "Specifies the HTTP method (GET or POST) used to request the VoiceUrl once incoming call connects.", "6-0": "voice_fallback_url", "6-1": "URL used if any errors occur during execution of InboundXML on a call or at initial request of the VoiceUrl.", "7-0": "voice_fallback_method", "7-1": "Specifies the HTTP method (GET or POST) used to request the VoiceFallBackUrl if it is needed.", "8-0": "voice_caller_id_lookup", "8-1": "Specifies if the incoming number has voice caller ID lookup enabled.", "9-0": "date_created", "9-1": "The date the incoming phone number resource was created.", "10-0": "date_updated", "10-1": "The date the incoming phone number resource was last updated.", "11-0": "sms_url", "11-1": "The URL returning InboundXML incoming phone numbers should execute when receiving an sms.", "12-0": "sms_method", "12-1": "The HTTP method used when making requests to the SmsUrl. Either GET or POST.", "13-0": "sms_fallback_url", "13-1": "URL used if any errors occur during execution of InboundXML from an sms or at initial request of the SmsUrl.", "14-0": "sms_fallback_method", "14-1": "Specifies the HTTP method (GET or POST) used to request the SmsFallbackUrl.", "15-0": "heartbeat_url", "15-1": "URL that can be used to monitor the phone number.", "16-0": "heartbeat_method", "16-1": "The HTTP method TelAPI will use when requesting the HeartbeatURL. Either GET or POST.", "17-0": "capabilities", "17-1": "The features available with this incoming phone number. The Elements voice and sms are nested within this property with their values as either True or False depending on what the number is capable of.", "18-0": "status_callback", "18-1": "URL that can be requested to receive notification when and how incoming call has ended.", "19-0": "status_callback_method", "19-1": "Specifies the HTTP method (GET or POST) used to request the HangupCallback URL.", "20-0": "hangup_callback", "20-1": "This is a StatusCallback clone that will be phased out in future versions.", "21-0": "hangup_callback_method", "21-1": "This is a StatusCallbackMethod clone that will be phased out in future versions.", "22-0": "api_version", "22-1": "The API version used with this incoming number.", "23-0": "uri", "23-1": "The Uniform Resource Identifier to this resource." }, "cols": 2, "rows": 24 } [/block] # **Example cURL** [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/IncomingPhoneNumbers/DIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -u 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:39xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "language": "shell" } ] } [/block]