Skip to main content
Paid plans only

​
recording-started

Fires for all participants when a recording starts.
​
action
string
Always "recording-started".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Unique ID for this recording instance.
​
type
string
The recording type: 'local', 'cloud', 'cloud-audio-only', or 'raw-tracks'.
​
local
boolean
Present only for local and cloud recordings, and only for the participant who started the recording.
​
recordingId
string
Present only for cloud recordings. The ID of the resulting recording.
​
startedBy
string
Present for cloud, cloud-audio-only, and raw-tracks recordings. The session_id of the participant who started the recording.
​
layout
DailyStreamingLayoutConfig
Present only for cloud recordings. The layout configuration. See DailyStreamingLayoutConfig for the full shape.
For local recordings, the participant who started the recording may receive additional fields, but other participants receive only action, instanceId, and callClientId.
// Example event object (cloud recording)
{
  "action": "recording-started",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "callClientId": "16149871051110.5607513282111183",
  "local": true,
  "recordingId": "cab2be92-1551-42d8-bcdf-11fe7bd81923",
  "startedBy": "1c6d5474-b133-4993-c943-f1ffdbb38cad",
  "type": "cloud"
}

​
recording-stopped

Fires for all participants when a recording stops.
​
action
string
Always "recording-stopped".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
ID of the recording instance that stopped.
// Example event object
{
  "action": "recording-stopped",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "callClientId": "16149871715780.8113693509425934"
}

​
recording-error

Fires when a recording error occurs.
​
action
string
Always "recording-error".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
ID of the recording instance that errored.
​
errorMsg
string
A human-readable description of the error.
// Example event object
{
  "action": "recording-error",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "errorMsg": "recording failed",
  "callClientId": "16149871715780.8113693509425934"
}

​
See also

Types

Methods

Guides