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>'
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 an Event=StopStream status callback if status_callback_url was configured.
This is the REST equivalent of sending a stop WebSocket event from your server. Both close the stream’s WebSocket. The difference: a server-side stop event also advances the call to the next XML element (or hangs up). This REST DELETE ends the fork; the call itself continues unless it has nothing else keeping it alive.
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. The body is empty. A 404 Not Found is returned if the stream_id is unknown, already stopped, or belongs to a different call. Treat stopping an already-stopped stream as idempotent in your code - the WebSocket may have already closed via caller hangup before your DELETE arrived.
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