Skip to main content
POST
Pause/Unpause Audio Stream

Path Parameters

id
string
required
streamId
string
required

Body

application/json
paused
boolean

Response

Pause state applied successfully

streamId
string
paused
boolean
positionSeconds
number<double>
mode
enum<string>

Playback mode. 'live' = at the live playhead; 'replay' = the call is still live but playback is offset behind the live playhead; 'recorded' = playing back a completed call recording.

Available options:
live,
replay,
recorded
bufferDurationSeconds
number<double>
pauseExpiresAtEpochSecond
integer<int64> | null

Epoch second when the pause will expire and the session will be closed. Null when the stream is not paused or when pause timeout is disabled. Re-sending the pause request resets this timer (heartbeat).