Audio Streams
Stop all Audio Streams
Stop every active audio stream running on a Vobiz call in one DELETE request - ideal for pipeline cleanup at call end or before transferring to a new flow.
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Stream
/
Stop all Audio Streams
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/ \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/
Each stream closed this way fires its own
Event=StopStream status callback (if status_callback_url was set on that stream) and closes its WebSocket. To stop a single fork while leaving others running, use Stop a Specific Audio Stream instead.Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth Token
string
required
Your Vobiz account ID, for example
MA_XXXXXXXX.Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your account ID. |
call_uuid | string | Yes | UUID of the call. |
string
required
Your Vobiz account ID. Use the same value in
X-Auth-ID.string
required
UUID of the call.
Response
Returns HTTP 204 No Content on success, even if the call currently has no active streams (the operation is idempotent).Example
cURL
curl -X DELETE 'https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/' \
-H 'X-Auth-ID: {auth_id}' \
-H 'X-Auth-Token: {auth_token}'
Was this page helpful?
⌘I
Stop all Audio Streams
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/ \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));