Skip to main content
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Stream
/
{stream_id}
Stop a stream
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/
This endpoint stops streaming for a specific stream_id without affecting other streams that may be running on the same call. Once stopped, Vobiz closes the WebSocket connection for that stream and sends a Stream stopped status callback if configured.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token

Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour account ID.
call_uuidstringYesUUID of the call.
stream_idstringYesID of the stream to stop.

Response

Returns HTTP 204 No Content on success.
Response - 404 Not Found
{
    "api_id": "correlation-id-uuid",
    "error": "Stream not found"
}

Example

cURL
curl -X DELETE 'https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/' \
  -H 'X-Auth-ID: {auth_id}' \
  -H 'X-Auth-Token: {auth_token}'

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

call_uuid
string
required
stream_id
string
required

Response

204

Stream stopped