Calls
Listen to Active Call
Initiate a live listen session for an active call
POST
Starts a live listen session for an active call, returning a WebSocket URL for real-time audio streaming.
Docs for agents: llms.txt
Authentication
string
required
Your API key for authentication
Path Parameters
string
required
The unique identifier of the call to listen to
Prerequisites
- Live listen must be enabled in organization preferences (
live_listen_enabled: true) - Call must be in active status (not completed)
- Call must belong to the authenticated organization
Response
string
Response status indicator
object
array
default:"null"
Array of error objects if request failed
WebSocket Connection
After receiving the WebSocket URL, connect to it to receive real-time audio data:Connection Details
- URL: Use the
urlreturned in the response - Protocol: WebSocket (WSS)
- Binary Type:
arraybuffer - Authentication: Handled via the URL token
Audio Data Format
The WebSocket streams binary audio data with these specifications:- Format: PCM Int16 (16-bit signed integers)
- Sample Rate: 16,000 Hz
- Channels: Mono (1 channel)
- Byte Order: Little-endian
- Data: Combined audio from all call participants
WebSocket Implementation Example
Error Codes
Notes
- WebSocket connection automatically closes when the call ends
- Multiple concurrent listeners can subscribe to the same call
- Audio stream includes all participants in the call (combined)
- The WebSocket URL can be used by multiple connections simultaneously
Docs for agents: llms.txt