Sample - Twilio API
POST/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json

Create a real-time transcription

Creates a real-time transcription associated with a call. Use the optional configuration fields to select tracks, callback delivery, language, recognition behavior, and supported transcription services. The created transcription begins with an in-progress status and can later be stopped by its SID or name.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 18 body fields
AccountSidstringrequired
The account SID that created the transcription. Must be a 34-character value matching `^AC[0-9a-fA-F]{32}$`.
CallSidstringrequired
The call SID associated with the transcription. Must be a 34-character value matching `^CA[0-9a-fA-F]{32}$`.

Optional real-time transcription configuration, including track selection, callbacks, recognition settings, and Intelligence Service integration.

Namestringoptional
The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
Trackstringoptional
One of `inbound_track`, `outbound_track`, `both_tracks`.
Allowed:inbound_trackoutbound_trackboth_tracks
StatusCallbackUrlstringoptional
Absolute URL of the status callback.
StatusCallbackMethodstringoptional
The http method for the status_callback (one of GET, POST).
Allowed:GETPOST
InboundTrackLabelstringoptional
Friendly name given to the Inbound Track
OutboundTrackLabelstringoptional
Friendly name given to the Outbound Track
PartialResultsbooleanoptional
Indicates if partial results are going to be sent to the customer
LanguageCodestringoptional
Language code used by the transcription engine, specified in [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format
TranscriptionEnginestringoptional
Definition of the transcription engine to be used, among those supported by Twilio
ProfanityFilterbooleanoptional
indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks
SpeechModelstringoptional
Recognition model used by the transcription engine, among those supported by the provider
Hintsstringoptional
A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them.
EnableAutomaticPunctuationbooleanoptional
The provider will add punctuation to recognition result
IntelligenceServicestringoptional
The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators
ConversationConfigurationstringoptional
The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service
ConversationIdstringoptional
The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service
TranscriptionConfigurationIdstringoptional
The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go.
EnableProviderDatabooleanoptional
Whether the callback includes raw provider data.

1 status code
200Returns the created transcription object with its transcription SID, account SID, associated call SID, name, status, update timestamp, and resource URI.
sidstringoptional
The SID of the Transcription resource.
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Transcription resource.
call_sidstringoptional
The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with.
namestringoptional
The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
statusstringoptional
The status - one of `stopped`, `in-flight`
Allowed:in-progressstopped
date_updatedstringoptional
The date and time in GMT that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
uristringoptional

Error handling

AccountSid must be a 34-character account SID and CallSid must be a 34-character call SID using the documented prefixes. Track must be inbound_track, outbound_track, or both_tracks; StatusCallbackMethod must be GET or POST, and StatusCallbackUrl must be an absolute URI when supplied.