Skip to main content
POST
Starts a live listen session for an active call, returning a WebSocket URL for real-time audio streaming.

Authentication

authorization
string
required
Your API key for authentication

Path Parameters

call_id
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

status
string
Response status indicator
data
object
errors
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 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 CodeDescription
MISSING_CALL_IDCall ID parameter is required
INVALID_ORG_PREFERENCESLive listen is not enabled for organization
CALL_NOT_FOUNDCall does not exist or does not belong to organization
INVALID_CALL_STATUSCall is not currently active
INTERNAL_SERVER_ERRORServer 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

Docs for agents: llms.txt