Skip to navigation

Transcription status callback

View as MarkdownOpen in Claude

Payload sent by SignalWire to your Transcription Status Callback URL when the status of a transcription changes.

Configure this callback by enabling transcription on a recording via the Record verb (transcribe=true) and setting transcribeCallback to your webhook URL.

Your app can use these parameters to handle the transcription — for example, uploading the text to your CRM, sending it via email, or forwarding the body via SignalWire SMS.

Status callbacks are advisory, best-effort notifications — delivery can be delayed or fail silently, so don’t gate time-critical actions on receiving one. See Status callback reliability.

Payload

The payload of this webhook request is an object.
TranscriptionSidstringRequired

The unique, 34-character ID of the transcription.

TranscriptionTextstringRequired
The text of the transcription.
TranscriptionStatusenumRequired
The status of the transcription.
Allowed values:
TranscriptionUrlstringRequired
The URL for the transcription's REST API resource.
RecordingSidstringRequired

The unique, 34-character identifier for the recording from which the transcription was generated.

RecordingUrlstringRequired
The URL for the audio recording from which the transcription was generated.

Response

200
Webhook received