{"__v":2,"_id":"54515edc14af501a00b50db7","category":{"__v":6,"_id":"54515eec14af501a00b50db9","pages":["54515edc14af501a00b50db7","545189db14af501a00b50e54","54517ea7a66f020800dbac36","545184faa66f020800dbac4d","54519946a66f020800dbaca8"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T21:41:00.904Z","from_sync":false,"order":11,"slug":"sip-domains","title":"SIP Domains"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"543ab20e48cf1f0800e11ee7","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-29T21:40:44.625Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"auth_type\": \"no_traffic\",\n  \"voice_status_callback_method\": \"POST\",\n  \"voice_heartbeat_callback\": null,\n  \"subresource_uris\": {\n    \"ip_access_control_list_mappings\": \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings\",\n    \"credential_list_mappings\": \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings\"\n  },\n  \"domain_sip_url\": \"test.sip.prd.telapi.com\",\n  \"date_updated\": \"Wed, 29 Oct 2014 23:35:04 -0000\",\n  \"voice_status_callback_url\": null,\n  \"uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains/SD7c8890849a8bf7c10ea649b88f8960cc\",\n  \"friendly_name\": \"{FriendlyName}\",\n  \"domain_name\": \"test\",\n  \"account_sid\": \"{AccountSid}\",\n  \"voice_url\": \"http://zang.io/ivr/welcome/call\",\n  \"voice_heartbeat_callback_method\": \"POST\",\n  \"sid\": \"{DomainSid}\",\n  \"date_created\": \"Wed, 29 Oct 2014 21:48:08 -0000\",\n  \"voice_fallback_method\": \"POST\",\n  \"voice_method\": \"POST\",\n  \"voice_fallback_url\": null\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":"54517c52a66f020800dbac32","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"54517c52a66f020800dbac31","ref":"","in":"path","required":true,"desc":"Domain SID.","default":"","type":"string","name":"DomainSid"}],"url":"/v2/Accounts/:AccountSid/SIP/Domains/:DomainSid.json"},"isReference":false,"order":0,"body":"# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"sid\",\n    \"1-0\": \"friendly_name\",\n    \"2-0\": \"account_sid\",\n    \"3-0\": \"domain_name\",\n    \"4-0\": \"auth_type\",\n    \"5-0\": \"voice_url\",\n    \"6-0\": \"voice_method\",\n    \"7-0\": \"voice_fallback_url\",\n    \"8-0\": \"voice_fallback_method\",\n    \"9-0\": \"voice_heartbeat_callback\",\n    \"10-0\": \"voice_heartbeat_callback_method\",\n    \"11-0\": \"voice_status_callback_url\",\n    \"12-0\": \"voice_status_callback_method\",\n    \"13-0\": \"date_created\",\n    \"14-0\": \"date_updated\",\n    \"15-0\": \"uri\",\n    \"16-0\": \"domain_sip_url\",\n    \"17-0\": \"subresource_uris\",\n    \"18-0\": \"ip_access_control_list_mappings\",\n    \"19-0\": \"credential_list_mappings\",\n    \"0-1\": \"An alphanumeric string identifying this resource.\",\n    \"1-1\": \"A human-readable name associated with this domain.\",\n    \"2-1\": \"An alphanumeric string identifying the account associated with this resource.\",\n    \"3-1\": \"A unique address through which you route your SIP traffic to TelAPI.\",\n    \"4-1\": \"The types of authentication associated with your domain. You must have at least one or all requests will be blocked.\\n\\n**Allowed Values**: IP_ACL and/or CREDENTIAL_LIST\",\n    \"5-1\": \"The URL requested when a call is received by your domain.\",\n    \"6-1\": \"The HTTP method used when requesting the VoiceUrl.\",\n    \"7-1\": \"The URL requested if the VoiceUrl fails.\",\n    \"8-1\": \"The HTTP method used when requesting the VoiceFallbackUrl.\",\n    \"9-1\": \"URL that can be requested every 60 seconds during the call to notify of elapsed time and pass other general information.\",\n    \"10-1\": \"Specifies the HTTP method used to request HeartbeatUrl.\\n\\n**Default Value**: POST  \\n**Allowed Value**: POST or GET\",\n    \"11-1\": \"The URL that TelAPI will use to send you status notifications regarding your SIP call.\",\n    \"12-1\": \"The HTTP method used when requesting the VoiceStatusCallback.\",\n    \"13-1\": \"The date this credential was created.\",\n    \"14-1\": \"The date the application resource was last updated.\",\n    \"15-1\": \"The Uniform Resource Identifier to this resource.\",\n    \"16-1\": \"Complete URL for this SIP domain.\",\n    \"17-1\": \"URIs for managing this resource (IP access control and credentials).\",\n    \"18-1\": \"URI for IP access controll management.\",\n    \"19-1\": \"URI for credentials management.\"\n  },\n  \"cols\": 2,\n  \"rows\": 20\n}\n[/block]\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}.json' -u '{AccountSid}:{AuthToken}'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"get info on your SIP domain","slug":"view-domain","type":"endpoint","title":"View Domain"}

getView Domain

get info on your SIP domain

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.
DomainSid:
required
string
Domain SID.

Result Format


Documentation

# **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "sid", "1-0": "friendly_name", "2-0": "account_sid", "3-0": "domain_name", "4-0": "auth_type", "5-0": "voice_url", "6-0": "voice_method", "7-0": "voice_fallback_url", "8-0": "voice_fallback_method", "9-0": "voice_heartbeat_callback", "10-0": "voice_heartbeat_callback_method", "11-0": "voice_status_callback_url", "12-0": "voice_status_callback_method", "13-0": "date_created", "14-0": "date_updated", "15-0": "uri", "16-0": "domain_sip_url", "17-0": "subresource_uris", "18-0": "ip_access_control_list_mappings", "19-0": "credential_list_mappings", "0-1": "An alphanumeric string identifying this resource.", "1-1": "A human-readable name associated with this domain.", "2-1": "An alphanumeric string identifying the account associated with this resource.", "3-1": "A unique address through which you route your SIP traffic to TelAPI.", "4-1": "The types of authentication associated with your domain. You must have at least one or all requests will be blocked.\n\n**Allowed Values**: IP_ACL and/or CREDENTIAL_LIST", "5-1": "The URL requested when a call is received by your domain.", "6-1": "The HTTP method used when requesting the VoiceUrl.", "7-1": "The URL requested if the VoiceUrl fails.", "8-1": "The HTTP method used when requesting the VoiceFallbackUrl.", "9-1": "URL that can be requested every 60 seconds during the call to notify of elapsed time and pass other general information.", "10-1": "Specifies the HTTP method used to request HeartbeatUrl.\n\n**Default Value**: POST \n**Allowed Value**: POST or GET", "11-1": "The URL that TelAPI will use to send you status notifications regarding your SIP call.", "12-1": "The HTTP method used when requesting the VoiceStatusCallback.", "13-1": "The date this credential was created.", "14-1": "The date the application resource was last updated.", "15-1": "The Uniform Resource Identifier to this resource.", "16-1": "Complete URL for this SIP domain.", "17-1": "URIs for managing this resource (IP access control and credentials).", "18-1": "URI for IP access controll management.", "19-1": "URI for credentials management." }, "cols": 2, "rows": 20 } [/block] # **Example cURL** [block:code] { "codes": [ { "code": "curl -X POST 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}.json' -u '{AccountSid}:{AuthToken}'", "language": "shell" } ] } [/block]