Skip to navigation
Compatibility REST APIRecording TranscriptionsWebhooks

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.

SignalWire sends the parameters as a form-encoded (application/x-www-form-urlencoded) POST body, not as JSON. When the callback method is GET, they are sent as query parameters instead.

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 path, relative to your Space URL, of the transcription's REST API resource.
RecordingSidstringRequired

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

RecordingUrlstringRequired
The path, relative to your Space URL, of the audio recording from which the transcription was generated.
CallSidstringRequired
A unique identifier for the recorded call.
AccountSidstringRequired
The unique ID of the project this transcription is associated with.
FromstringRequired
The phone number that placed the recorded call, in E.164 format.
TostringRequired
The phone number that received the recorded call, in E.164 format.
CallStatusenumRequired
The status of the recorded call at the time of the callback.
ApiVersionstringRequired
The version of the SignalWire API.
DirectionenumRequired

The direction of the recorded call.

  • outbound-dial: calls launched through the Dial verb.
  • outbound-api: calls launched through the REST API.
  • inbound: inbound calls.
Allowed values:

Response

200
Webhook received