transcribe

Transcribe the entire call in the background. Execution continues to the next instruction while the call proceeds; the transcription covers the whole call and completes when the call ends. To stop it early, use the transcribe_stop method.

For real-time transcription delivered as the call happens, use live_transcribe instead.

Only one transcription can be active on a call at a time. Starting another while one is already running will fail.

Properties

Variables

StatusCallbacks

When you set status_url, SignalWire POSTs a transcript event to it when the call’s transcription finishes: calling.transcript.completed includes the transcribed text when speech was captured, or calling.transcript.failed if the call could not be transcribed.

1
{
2
  "event_type": "calling.transcript.completed",
3
  "timestamp": 1777565701.5623918,
4
  "project_id": "4d0d6f16-5881-4fcc-92a4-02c51a91954d",
5
  "space_id": "451ed9ff-e568-4222-8af9-4f9ab7428d09",
6
  "params": {
7
    "id": "0ec5a4da-46b9-4d2c-b724-151add8d4d08",
8
    "call_id": "2e1e66e5-5d07-413d-9668-55542992eec0",
9
    "segment_id": "2e1e66e5-5d07-413d-9668-55542992eec0"
10
  }
11
}

See the Transcript status callback webhook page for the full field reference.

Example

1
version: 1.0.0
2
sections:
3
  main:
4
    - transcribe:
5
        status_url: https://example.com/transcribe-status