REST ClientCalling

transcribe

View as MarkdownOpen in Claude

Start transcribing an active call in the background. The transcription covers the whole call and completes when the call ends. For real-time transcription, use live transcription. Status updates are delivered to the optional status_url. Supply a control_id so you can stop the transcription later with transcribe_stop.

Request

idstringRequiredformat: "uuid"
The unique identifying ID of an existing call.
paramsobjectRequired
An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired
Returned when the call is a standard PSTN, SIP, or WebRTC call.
OR
Fabric Subscriber Device LegobjectRequired

Example

from signalwire.rest import RestClient
client = RestClient(
project="your-project-id",
token="your-api-token",
host="your-space.signalwire.com",
)
client.calling.transcribe(
call_id="call-id-xxx",
control_id="transcribe-1",
status_url="https://example.com/transcribe-status",
)