Start an audio stream on a live call
start_audio_streamFork live Vobiz call audio to your WebSocket server in near real time for live transcription or AI voice agents. Returns a stream_id.
Instructions
Fork the audio of a LIVE Vobiz call to your WebSocket server in near real time (POST /Call/{uuid}/Stream/), for example for live transcription or an AI voice agent. service_url must be wss:// on an approved host. bidirectional: true lets your server play audio back into the call and requires audio_track inbound (the default when bidirectional). content_type sets the inbound audio format (L16 8 kHz default, L16 16 kHz, or mu-law 8 kHz). Returns a stream_id for get_audio_stream / stop_audio_stream. This sends live call audio to an external server, so it requires confirm: true after the user approves the destination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly approved: sending this call's live audio to this WebSocket server. | |
| call_uuid | Yes | ||
| audio_track | No | Which audio to fork. Default both; must be inbound when bidirectional is true. | |
| service_url | Yes | wss:// URL of your WebSocket server (approved host). | |
| content_type | No | Inbound audio format sent to your server. Default audio/x-l16;rate=8000. | |
| bidirectional | No | Allow your server to send audio back into the call (playAudio). Default false. | |
| extra_headers | No | Comma-separated header:value pairs (e.g. X-Session:abc123) passed with the stream. Use the wss:// URL path, not these headers, to authenticate the socket. | |
| stream_timeout | No | Stop the stream automatically after this many seconds. Default 86400. | |
| status_callback_url | No | https URL (approved host) that receives stream status events (StartStream, PlayedStream, StopStream...). | |
| status_callback_method | No | Default POST. |