Transcription events

transcription-started

Fires for all participants when transcription starts.

string

Always "transcription-started".

string

The ID of the call client instance that emitted this event.

string

Unique ID for this transcription instance.

string

Optional ID of the resulting transcript.

string

Language code passed to Deepgram (e.g. 'en').

string

The Deepgram model in use (e.g. 'general').

string

Optional Deepgram tier.

boolean

Optional. Whether profanity filtering is enabled.

Array | boolean

Optional redaction configuration.

number | boolean

Optional endpointing setting.

boolean

Optional. Whether punctuation is added to transcriptions.

object

Optional extra Deepgram parameters.

boolean

Optional. When true, transcription-message events include a rawResponse field with the raw Deepgram response.

string

The session_id of the participant who started transcription.

// Example event object
{
  "action": "transcription-started",
  "callClientId": "16323425945550.36134184140203573",
  "instanceId": "a1f2f6b7-b1ac-4202-85e5-d446cb6c3d3f",
  "transcriptId": "transcript-abc123",
  "language": "en",
  "model": "general",
  "startedBy": "049ebba2-523b-4e6c-9a9f-1f8bb956670d"
}

transcription-stopped

Fires for all participants when transcription stops.

string

Always "transcription-stopped".

string

The ID of the call client instance that emitted this event.

string

ID of the transcription instance that stopped.

string

The session_id of the participant who stopped transcription.

// Example event object
{
  "action": "transcription-stopped",
  "callClientId": "16323425945550.36134184140203573",
  "instanceId": "a1f2f6b7-b1ac-4202-85e5-d446cb6c3d3f",
  "updatedBy": "049ebba2-523b-4e6c-9a9f-1f8bb956670d"
}

transcription-message

Fires for all participants when a new transcription snippet is available.

string

Always "transcription-message".

string

The ID of the call client instance that emitted this event.

string

Optional ID of the transcription instance.

string

The session_id of the participant who spoke.

string

Optional. Which track was transcribed: 'cam-audio', 'screen-audio', 'rmpAudio', or a custom track name.

string

The transcribed text.

Date

When the transcription was produced.

object

Raw response from Deepgram. Only present when includeRawResponse was true when transcription started.

// Example event object
{
  "action": "transcription-message",
  "callClientId": "17026592880190.6408519754664044",
  "instanceId": "a1f2f6b7-b1ac-4202-85e5-d446cb6c3d3f",
  "participantId": "9c50d278-abb4-433e-a8b0-3964d363416a",
  "trackType": "cam-audio",
  "text": "Good morning.",
  "timestamp": "2023-12-15T16:55:02.000Z"
}

call.on('transcription-message', ({ participantId, text, timestamp }) => {
  appendTranscriptLine(participantId, text, timestamp);
});

transcription-error

Fires for all participants when a transcription error occurs.

string

Always "transcription-error".

string

The ID of the call client instance that emitted this event.

string

ID of the transcription instance that errored.

string

Optional human-readable error description.

// Example event object
{
  "action": "transcription-error",
  "callClientId": "16323425945550.36134184140203573",
  "instanceId": "a1f2f6b7-b1ac-4202-85e5-d446cb6c3d3f",
  "errorMsg": "Transcription service unavailable"
}

Methods

Guides

Live streaming events Telephony events (SIP/PSTN)

Daily Call Client

Types

Static Methods

Instance Methods

Events

Transcription events

transcription-started

transcription-stopped

transcription-message

transcription-error

See also

Methods

Guides

​transcription-started

​transcription-stopped

​transcription-message

​transcription-error

​See also

Methods

Guides

transcription-started

transcription-stopped

transcription-message

transcription-error

See also