Authentication
Your API key for authentication
Path Parameters
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
Response status indicator
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
url
returned 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
Error Code | Description |
---|---|
MISSING_CALL_ID | Call ID parameter is required |
INVALID_ORG_PREFERENCES | Live listen is not enabled for organization |
CALL_NOT_FOUND | Call does not exist or does not belong to organization |
INVALID_CALL_STATUS | Call is not currently active |
INTERNAL_SERVER_ERROR | Server error occurred |
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