Skip to main content

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.

The Stream object represents an audio stream attached to an active call. It captures the configuration you provided when starting the stream (WebSocket URL, codec, track, bidirectional mode) along with runtime metadata such as status, start time, and end time.
A single call may have multiple concurrent streams. Each stream is identified by a unique stream_id and can be stopped independently.

​
Attributes

FieldTypeDescription
stream_idstringUnique identifier for the stream. Used in API operations to identify specific streams.
call_uuidstringThe UUID of the call this stream is attached to.
service_urlstringWebSocket URL (wss:// or ws://) to which Vobiz forwards the forked audio.
audio_trackstringWhich audio track is being streamed. One of “inbound”, “outbound”, “both”.
bidirectionalbooleanWhether the WebSocket is also allowed to send audio back into the call.
content_typestringAudio content type. One of “audio/x-l16”, “audio/x-mulaw”.
sampling_rateintegerAudio sample rate in Hz. One of 8000, 16000.
stream_timeoutintegerMaximum stream duration in seconds. The stream is automatically stopped when this limit is reached.
status_callback_urlstringURL invoked via HTTP POST when the stream status changes (connected, stopped, timeout, failed).
status_callback_methodstringHTTP method used to invoke status_callback_url. One of “GET”, “POST”. Default: “POST”.
statusstringCurrent status of the stream. One of “in-progress”, “completed”, “failed”.
start_timestringTimestamp when the stream started (ISO 8601 with timezone).
end_timestringTimestamp when the stream ended. Null while the stream is still active.
resource_uristringRelative URI of this Stream resource.

​
Example

Stream Object
{
    "api_id": "15b27100-1231-11ee-b875-0242ac110003",
    "call_uuid": "6e558798-499c-4a68-bc77-46f2c53d1f69",
    "stream_id": "2b1b3f8e-4c9a-4f2a-9e2d-7f9d0b1c2a34",
    "service_url": "wss://example.com/audio-stream",
    "audio_track": "inbound",
    "bidirectional": false,
    "content_type": "audio/x-l16",
    "sampling_rate": 8000,
    "stream_timeout": 86400,
    "status_callback_url": "https://example.com/stream-status",
    "status_callback_method": "POST",
    "status": "in-progress",
    "start_time": "2025-11-06 13:49:10+00:00",
    "end_time": null,
    "resource_uri": "/v1/Account/MA_PU0XU668/Call/6e558798-499c-4a68-bc77-46f2c53d1f69/Stream/2b1b3f8e-4c9a-4f2a-9e2d-7f9d0b1c2a34/"
}