Transcription
The <Transcription>
verb enables real-time speech-to-text transcription for the call.
Attributes
ATTRIBUTE | DESCRIPTION | OPTIONS | DEFAULT |
---|---|---|---|
language | Language to use for speech recognition. | de , en , es , fr , it , pl | en |
interimResults | Whether to send also interim results. If set to false, only final results will be sent. Applies to transcriptionEngine A only. | false | |
transcriptionEngine | Engine to use for speech recognition. | A , B | A |
transcriptionTracks | Indicates which leg of the call will be transcribed. Use inbound for the leg that requested the transcription, outbound for the other leg, and both for both legs of the call. | inbound , outbound , both | inbound |
transcriptionCallback | URL that tells Telnyx where to make its GET or POST requests with transcription data. | - | |
transcriptionCallbackMethod | HTTP request type used for transcriptionCallback. | GET , POST | POST |
Examples
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Start>
<Transcription language="en" interimResults="true" transcriptionCallback="/transcription" />
</Start>
</Response>
Expected callbacks
transcription-callback
{
"AccountSid": params.user_id,
"CallSid" => call_sid,
"CallSidLegacy" => call_sid,
"Transcript" => params.transcript,
"IsFinal" => params.is_final,
"Confidence" => params.confidence
}
Status callback HTTP attributes
ATTRIBUTE | DESCRIPTION |
AccountSid | A unique identifier for the account generating this call. |
CallSid | A unique identifier for this call, generated by Telnyx. |
CallSidLegacy | A unique identifier for the call sent to keep backward compatibility. |
Transcript | The result of the transcription. |
IsFinal | Indicates if the provided transcription is final, supported by engine A only |
Confidence | Indicates the level of confidence in the accuracy of the transcription. Possible value 1 (high confidence) - 0 (low confidence), supported by engine A only |