{"__v":7,"_id":"545189db14af501a00b50e54","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":10,"slug":"sip-domains","title":"SIP Domains"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"543ab20e48cf1f0800e11ee7","version":{"__v":29,"_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"],"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-30T00:44:11.036Z","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}/SIP/Domains.json?Page=0&PageSize=50\",\n  \"end\": 1,\n  \"total\": 2,\n  \"previous_page_uri\": \"\",\n  \"num_pages\": 1,\n  \"uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains.json\",\n  \"page_size\": 50,\n  \"start\": 0,\n  \"next_page_uri\": \"\",\n  \"last_page_uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains.json?Page=0&PageSize=50\",\n  \"page\": 0,\n  \"domains\": [\n    \n    {\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\":\n        \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings\",\n        \"credential_list_mappings\":\n        \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings\"\n      },\n      \"domain_sip_url\": \"test1.sip.prd.telapi.com\",\n      \"date_updated\": \"Thu, 30 Oct 2014 00:00:35 -0000\",\n      \"voice_status_callback_url\": null,\n      \"uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}\",\n      \"friendly_name\": \"{FriendlyName}\",\n      \"domain_name\": \"test1\",\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\": \"Thu, 30 Oct 2014 00:00:35 -0000\",\n      \"voice_fallback_method\": \"POST\",\n      \"voice_method\": \"POST\",\n      \"voice_fallback_url\": null\n    },\n    \n    {\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\":\n        \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings\",\n        \"credential_list_mappings\":\n        \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings\"\n      },\n      \"domain_sip_url\": \"test.sip.prd.telapi.com\",\n      \"date_updated\": \"Thu, 30 Oct 2014 00:31:56 -0000\",\n      \"voice_status_callback_url\": null,\n      \"uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}\",\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    }\n  \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":"545195e614af501a00b50e9a","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"}],"url":"/v2/Accounts/:AccountSid/SIP/Domains.json"},"isReference":false,"order":1,"body":"# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\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    \"3-0\": \"previous_page_uri\",\n    \"4-0\": \"num_pages\",\n    \"5-0\": \"uri\",\n    \"6-0\": \"page_size\",\n    \"7-0\": \"start\",\n    \"8-0\": \"next_page_uri\",\n    \"9-0\": \"last_page_uri\",\n    \"10-0\": \"page\",\n    \"11-0\": \"domains\",\n    \"12-0\": \"\",\n    \"12-1\": \"\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"13-0\": \"\",\n    \"13-1\": \"\",\n    \"14-0\": \"\",\n    \"14-1\": \"\",\n    \"15-0\": \"\",\n    \"15-1\": \"\",\n    \"16-0\": \"\",\n    \"16-1\": \"\",\n    \"17-0\": \"\",\n    \"17-1\": \"\",\n    \"18-0\": \"\",\n    \"18-1\": \"\",\n    \"19-0\": \"\",\n    \"19-1\": \"\",\n    \"20-0\": \"\",\n    \"20-1\": \"\",\n    \"21-0\": \"\",\n    \"21-1\": \"\",\n    \"22-0\": \"\",\n    \"22-1\": \"\",\n    \"23-0\": \"\",\n    \"23-1\": \"\",\n    \"24-0\": \"\",\n    \"24-1\": \"\",\n    \"25-0\": \"\",\n    \"25-1\": \"\",\n    \"26-0\": \"\",\n    \"26-1\": \"\",\n    \"11-1\": \"Array containing the domains information.\",\n    \"10-1\": \"Current page number.\",\n    \"2-1\": \"Number of items.\",\n    \"3-1\": \"URI for the previous page of results.\",\n    \"4-1\": \"Number of pages.\",\n    \"5-1\": \"The Uniform Resource Identifier to this resource.\",\n    \"6-1\": \"Number of items on a single page.\",\n    \"7-1\": \"Index of the first item on the current page.\",\n    \"8-1\": \"URI for the next page of the results.\",\n    \"9-1\": \"URI for the last page of the results.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\nReturn parameters for domains are equal to those on [\"View Domain\" API call](/v2/docs/view-domain).\n\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains.json' -u '{AccountSid}:{AuthToken}'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"list all your SIP domains","slug":"list-domains","type":"endpoint","title":"List Domains"}

getList Domains

list all your SIP domains

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.

Result Format


Documentation

# **Response Parameters** [block:parameters] { "data": { "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", "3-0": "previous_page_uri", "4-0": "num_pages", "5-0": "uri", "6-0": "page_size", "7-0": "start", "8-0": "next_page_uri", "9-0": "last_page_uri", "10-0": "page", "11-0": "domains", "12-0": "", "12-1": "", "h-0": "Parameter", "h-1": "Description", "13-0": "", "13-1": "", "14-0": "", "14-1": "", "15-0": "", "15-1": "", "16-0": "", "16-1": "", "17-0": "", "17-1": "", "18-0": "", "18-1": "", "19-0": "", "19-1": "", "20-0": "", "20-1": "", "21-0": "", "21-1": "", "22-0": "", "22-1": "", "23-0": "", "23-1": "", "24-0": "", "24-1": "", "25-0": "", "25-1": "", "26-0": "", "26-1": "", "11-1": "Array containing the domains information.", "10-1": "Current page number.", "2-1": "Number of items.", "3-1": "URI for the previous page of results.", "4-1": "Number of pages.", "5-1": "The Uniform Resource Identifier to this resource.", "6-1": "Number of items on a single page.", "7-1": "Index of the first item on the current page.", "8-1": "URI for the next page of the results.", "9-1": "URI for the last page of the results." }, "cols": 2, "rows": 12 } [/block] Return parameters for domains are equal to those on ["View Domain" API call](/v2/docs/view-domain). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains.json' -u '{AccountSid}:{AuthToken}'", "language": "shell" } ] } [/block]