{"_id":"543acbefe14e09080000a0ac","parentDoc":null,"category":{"_id":"54538e5608d1800800473d9a","project":"542dbe0ecb19820800c1f4d7","__v":0,"pages":["542ef4fd1161420800d8370c","544a9f7c4688c708001866a2","544ab18abb58010800710b86","543acbefe14e09080000a0ac","544c5f7236475e0e005014c7","543bd73c5e7c871600f190da","543bf3f25e7c871600f19170","544577290a8dbc1a00ff6a23"],"version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-31T13:27:50.899Z","from_sync":false,"order":2,"slug":"calls","title":"Calls"},"editedParams2":true,"project":"542dbe0ecb19820800c1f4d7","version":{"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","__v":31,"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"},"editedParams":true,"is_link":false,"__v":7,"user":"542dc547cb19820800c1f4f1","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-12T18:43:59.011Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"method":"post","results":{"codes":[{"name":"Success","code":"{\n    \"sid\": \"{CallSid}\",\n    \"date_created\": \"Tue, 24 Jul 2012 14:56:32 +0000\",\n    \"date_updated\": \"Tue, 24 Jul 2012 14:56:35 +0000\",\n    \"parent_call_sid\": \"\",\n    \"account_sid\": \"{AccountSid}\",\n    \"to\": \"+14245555526\",\n    \"from\": \"+17325551300\",\n    \"phone_number_sid\": \"{phone_number_sid}\",\n    \"status\": \"completed\",\n    \"start_time\": \"Tue, 24 Jul 2012 14:56:32 +0000\",\n    \"end_time\": \"Tue, 24 Jul 2012 14:56:35 +0000\",\n    \"duration\": \"3\",\n    \"price\": \"0.020000\",\n    \"direction\": \"outbound-api\",\n    \"answered_by\": \"None\",\n    \"api_version\": \"v2\",\n    \"forwarded_from\": \"\",\n    \"p_asserted_identity\": \"\",\n    \"sip_privacy\": \"\",\n    \"privacy_hide_number\": \"False\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}.json\",\n    \"subresource_uris\": {\n        \"notifications\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json\",\n        \"recordings\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json\"\n    }\n}        ","language":"json"},{"code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404,"name":"Failure"}]},"try":true,"examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"543bc6302a30961a00b66dfc","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"543bc6302a30961a00b66dfb","ref":"","in":"path","required":true,"desc":"Call SID.","default":"","type":"string","name":"CallSid"},{"_id":"543bc6302a30961a00b66dfa","ref":"","in":"body","required":false,"desc":"The URL that in-progress calls will request for new instructions.","default":"","type":"string","name":"Url"},{"_id":"543bc6ad2a30961a00b66dfd","ref":"","in":"body","required":false,"desc":"The HTTP method used to request the redirect URL. Valid parameters are GET and POST.","default":"POST","type":"string","name":"Method"},{"_id":"543bc89d5e7c871600f190c1","ref":"","in":"body","required":false,"desc":"The status used to end the call. Allowed values are \"canceled\" for ending queued or ringing calls, and \"completed\" to end in-progress calls in addition to queued and ringing calls.","default":"","type":"string","name":"Status"}],"url":"/v2/Accounts/:AccountSid/Calls/:CallSid.json"},"isReference":false,"order":3,"body":"Zang provides granular, real-time control over live calls. Just POST to the Call Sid with a Url pointing to new instructions or end the call with a Status.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Parameters\"\n}\n[/block]\nResponse parameters are equal to those on [\"View Call\" API call](/v2/docs/view-call).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example cURL\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST 'https://api.zang.io/v2/Accounts/{AccountSid}/Calls/{CallSid}.json' -u '{AccountSid}:{AuthToken}' -d 'Status=completed'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If you're using cURL on Windows, be sure to change those single quotes to double quotes!\"\n}\n[/block]","excerpt":"send new instructions to the call","slug":"interrupt-live-call","type":"endpoint","title":"Interrupt Live Call"}

postInterrupt Live Call

send new instructions to the call

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.
CallSid:
required
string
Call SID.

Body Params

Url:
string
The URL that in-progress calls will request for new instructions.
Method:
stringPOST
The HTTP method used to request the redirect URL. Valid parameters are GET and POST.
Status:
string
The status used to end the call. Allowed values are "canceled" for ending queued or ringing calls, and "completed" to end in-progress calls in addition to queued and ringing calls.

Result Format


Documentation

Zang provides granular, real-time control over live calls. Just POST to the Call Sid with a Url pointing to new instructions or end the call with a Status. [block:api-header] { "type": "basic", "title": "Response Parameters" } [/block] Response parameters are equal to those on ["View Call" API call](/v2/docs/view-call). [block:api-header] { "type": "basic", "title": "Example cURL" } [/block] [block:code] { "codes": [ { "code": "curl -X POST 'https://api.zang.io/v2/Accounts/{AccountSid}/Calls/{CallSid}.json' -u '{AccountSid}:{AuthToken}' -d 'Status=completed'", "language": "shell" } ] } [/block] [block:callout] { "type": "warning", "body": "If you're using cURL on Windows, be sure to change those single quotes to double quotes!" } [/block]