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 Audio Streams API lets you fork the audio of a live call to a WebSocket server in near real time. You can start and stop streams dynamically during the call, retrieve the list of active streams, and optionally send audio back into the call using bidirectional streaming.

​
Key Capabilities

  • Real-time Audio - Fork inbound, outbound, or both tracks of a live call to your WebSocket in near real time.
  • Bidirectional Mode - Enable bidirectional=true to send audio from your server back into the call.
  • Flexible Codecs - Choose audio/x-l16 or audio/x-mulaw at 8 kHz or 16 kHz sample rates.
  • Status Callbacks - Receive stream lifecycle events (connected, stopped, timeout, failed) on your callback URL.
Important: Your WebSocket server must accept connections over wss://. Audio packets are delivered as JSON frames containing base64-encoded payloads. See the Stream XML element to start streams from XML instead of the API.

​
API Endpoint

Base URL 
https://api.vobiz.ai/api/v1
Stream Base URI 
https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/
Authentication required:
  • X-Auth-ID - Your account ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Available Operations

MethodOperationDescription
OBJECTThe Stream objectComplete structure and attributes of an audio Stream object including status, timing, and configuration fields.
POSTStart an audio streamStart streaming audio from an active call to your WebSocket server with configurable tracks, codecs, and bidirectional mode.
GETRetrieve an audio streamGet details of a specific audio stream on a call using its stream ID.
GETList all audio streamsRetrieve all audio streams attached to a given call.
DELETEStop a specific audio streamStop a single active audio stream on a call by its stream ID.
DELETEStop all audio streamsStop every active audio stream currently running on a call in one request.
Note: Audio streams are billed per minute of audio forked. Stopping a stream immediately halts billing for that stream.