Skip to main content

​
transcription-started

Fires for all participants when transcription starts.
​
action
string
Always "transcription-started".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Unique ID for this transcription instance.
​
transcriptId
string
Optional ID of the resulting transcript.
​
language
string
Language code passed to Deepgram (e.g. 'en').
​
model
string
The Deepgram model in use (e.g. 'general').
​
tier
string
Optional Deepgram tier.
​
profanity_filter
boolean
Optional. Whether profanity filtering is enabled.
​
redact
Array | boolean
Optional redaction configuration.
​
endpointing
number | boolean
Optional endpointing setting.
​
punctuate
boolean
Optional. Whether punctuation is added to transcriptions.
​
extra
object
Optional extra Deepgram parameters.
​
includeRawResponse
boolean
Optional. When true, transcription-message events include a rawResponse field with the raw Deepgram response.
​
startedBy
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.
​
action
string
Always "transcription-stopped".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
ID of the transcription instance that stopped.
​
updatedBy
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.
​
action
string
Always "transcription-message".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Optional ID of the transcription instance.
​
participantId
string
The session_id of the participant who spoke.
​
trackType
string
Optional. Which track was transcribed: 'cam-audio', 'screen-audio', 'rmpAudio', or a custom track name.
​
text
string
The transcribed text.
​
timestamp
Date
When the transcription was produced.
​
rawResponse
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.
​
action
string
Always "transcription-error".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
ID of the transcription instance that errored.
​
errorMsg
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"
}

​
See also

Methods

Guides