{"__v":5,"_id":"545184faa66f020800dbac4d","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-30T00:23:22.288Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"post","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\": \"Thu, 30 Oct 2014 00:24:48 -0000\",\n  \"voice_status_callback_url\": null,\n  \"uri\": \"/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}\",\n  \"friendly_name\": \"Test1\",\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":"54518707a66f020800dbac5e","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"54518707a66f020800dbac5d","ref":"","in":"path","required":true,"desc":"Domain SID.","default":"","type":"string","name":"DomainSid"},{"_id":"54518707a66f020800dbac5c","ref":"","in":"body","required":false,"desc":"A human-readable name associated with this domain.","default":"","type":"string","name":"FriendlyName"},{"_id":"54518707a66f020800dbac5b","ref":"","in":"body","required":false,"desc":"The URL requested when a call is received by your domain.","default":"","type":"string","name":"VoiceUrl"},{"_id":"54518707a66f020800dbac5a","ref":"","in":"body","required":false,"desc":"The HTTP method used when requesting the VoiceUrl.","default":"","type":"string","name":"VoiceMethod"},{"_id":"54518707a66f020800dbac59","ref":"","in":"body","required":false,"desc":"The URL requested if the VoiceUrl fails.","default":"","type":"string","name":"VoiceFallbackUrl"},{"_id":"54518707a66f020800dbac58","ref":"","in":"body","required":false,"desc":"The HTTP method used when requesting the VoiceFallbackUrl.","default":"","type":"string","name":"VoiceFallbackMethod"},{"_id":"54518707a66f020800dbac57","ref":"","in":"body","required":false,"desc":"URL that can be requested every 60 seconds during the call to notify of elapsed time and pass other general information.","default":"","type":"string","name":"HeartbeatUrl"},{"_id":"54518707a66f020800dbac56","ref":"","in":"body","required":false,"desc":"Specifies the HTTP method used to request HeartbeatUrl.","default":"POST","type":"string","name":"HeartbeatMethod"},{"_id":"54518707a66f020800dbac55","ref":"","in":"body","required":false,"desc":"The URL that TelAPI will use to send you status notifications regarding your SIP call.","default":"","type":"string","name":"VoiceStatusCallback"},{"_id":"54518707a66f020800dbac54","ref":"","in":"body","required":false,"desc":"The HTTP method used when requesting the VoiceStatusCallback.","default":"","type":"string","name":"VoiceStatusCallbackMethod"}],"url":"/v2/Accounts/:AccountSid/SIP/Domains/:DomainSid.json"},"isReference":false,"order":3,"body":"# **Response Parameters**\n\nResponse parameters 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 POST 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}.json' -u '{AccountSid}:{AuthToken}' -d 'FriendlyName=Test1'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"updates SIP domain","slug":"update-domain","type":"endpoint","title":"Update Domain"}

postUpdate Domain

updates SIP domain

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

FriendlyName:
string
A human-readable name associated with this domain.
VoiceUrl:
string
The URL requested when a call is received by your domain.
VoiceMethod:
string
The HTTP method used when requesting the VoiceUrl.
VoiceFallbackUrl:
string
The URL requested if the VoiceUrl fails.
VoiceFallbackMethod:
string
The HTTP method used when requesting the VoiceFallbackUrl.
HeartbeatUrl:
string
URL that can be requested every 60 seconds during the call to notify of elapsed time and pass other general information.
HeartbeatMethod:
stringPOST
Specifies the HTTP method used to request HeartbeatUrl.
VoiceStatusCallback:
string
The URL that TelAPI will use to send you status notifications regarding your SIP call.
VoiceStatusCallbackMethod:
string
The HTTP method used when requesting the VoiceStatusCallback.

Result Format


Documentation

# **Response Parameters** Response parameters are equal to those on ["View Domain" API call](/v2/docs/view-domain). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X POST 'https://api.zang.io/v2/Accounts/{AccountSid}/SIP/Domains/{DomainSid}.json' -u '{AccountSid}:{AuthToken}' -d 'FriendlyName=Test1'", "language": "shell" } ] } [/block]