Skip to content Skip to navigation Skip to topbar

Page tools

On this page

Looking for more inspiration?Visit the

Calls Transcriptions subresource

(new)

Legal notice

Real-Time Transcriptions, including the <Transcriptions> TwiML noun and API, use artificial intelligence or machine learning technologies. By enabling or using any of the features or functionalities within Programmable Voice that are identified as using artificial intelligence or machine learning technology, you acknowledge and agree that your use of these features or functionalities is subject to the terms of the Predictive and Generative AI/ML Features Addendum.

Transcriptions is a subresource of Calls and represents a real-time audio transcription during a live call. You can start and stop a transcription on any in-progress call via API or via the <Transcription> TwiML Noun.

To start a real-time transcription on a live call, create a Transcription.
To stop a real-time transcription, update a Transcription status.

Calls Transcriptions properties

Property nameTypeRequiredPIIDescriptionChild properties

sidSID<GT>

Optional

The SID of the Transcription resource.

Pattern: ^GT[0-9a-fA-F]{32}$Min length: 34Max length: 34

accountSidSID<AC>

Optional

The SID of the Account that created this Transcription resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

Optional

The SID of the Call the Transcription resource is associated with.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

namestring

Optional

The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.

statusenum<string>

Optional

The status - one of stopped, in-flight

Possible values:

in-progressstopped

dateUpdatedstring<date-time-rfc-2822>

Optional

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.

uristring

Optional

Create a Transcription

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

The SID of the Account that created this Transcription resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

required

The SID of the Call the Transcription resource is associated with.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

namestring

Optional

The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.

trackenum<string>

Optional

Possible values:

inbound_trackoutbound_trackboth_tracks

statusCallbackUrlstring<uri>

Optional

Absolute URL of the status callback.

statusCallbackMethodenum<http-method>

Optional

The http method for the status_callback (one of GET, POST).

Possible values:

GETPOST

inboundTrackLabelstring

Optional

Friendly name given to the Inbound Track

outboundTrackLabelstring

Optional

Friendly name given to the Outbound Track

partialResultsboolean

Optional

Indicates if partial results are going to be sent to the customer

languageCodestring

Optional

Language code used by the transcription engine, specified in BCP-47 format

transcriptionEnginestring

Optional

Definition of the transcription engine to be used, among those supported by Twilio

profanityFilterboolean

Optional

indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks

speechModelstring

Optional

Recognition model used by the transcription engine, among those supported by the provider

hintsstring

Optional

A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them.

enableAutomaticPunctuationboolean

Optional

The provider will add punctuation to recognition result

intelligenceServicestring

Optional

The SID or unique name of the Intelligence Service for persisting transcripts and running post-call Language Operators .

Create a Transcription

1// Download the helper library from https://www.twilio.com/docs/node/install 
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio"; 
3 
4// Find your Account SID and Auth Token at twilio.com/console 
5// and set the environment variables. See http://twil.io/secure 
6const accountSid = process.env.TWILIO_ACCOUNT_SID; 
7const authToken = process.env.TWILIO_AUTH_TOKEN; 
8const client = twilio(accountSid, authToken); 
9 
10async function createRealtimeTranscription() { 
11 const transcription = await client 
12 .calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") 
13 .transcriptions.create(); 
14 
15 console.log(transcription.sid); 
16} 
17 
18createRealtimeTranscription();

Response

1{ 
2 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
3 "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
4 "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
5 "name": null, 
6 "status": "in-progress", 
7 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", 
8 "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" 
9}

Update a Transcription

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

The SID of the Account that created this Transcription resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

required

The SID of the Call the Transcription resource is associated with.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidstring

required

The SID of the Transcription resource, or the name used when creating the resource

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

statusenum<string>

required

Possible values:

stopped

You can stop an in-progress Transcription by updating the status to stopped. You can also use TwiML to stop a Transcription.

When making this request, you can use the Transcription subresource's SID or the name (if one was given when the Transcription was created).

Stop a real-time Transcription

1// Download the helper library from https://www.twilio.com/docs/node/install 
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio"; 
3 
4// Find your Account SID and Auth Token at twilio.com/console 
5// and set the environment variables. See http://twil.io/secure 
6const accountSid = process.env.TWILIO_ACCOUNT_SID; 
7const authToken = process.env.TWILIO_AUTH_TOKEN; 
8const client = twilio(accountSid, authToken); 
9 
10async function updateRealtimeTranscription() { 
11 const transcription = await client 
12 .calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") 
13 .transcriptions("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") 
14 .update({ status: "stopped" }); 
15 
16 console.log(transcription.sid); 
17} 
18 
19updateRealtimeTranscription();

Response

1{ 
2 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
3 "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
4 "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 
5 "name": null, 
6 "status": "stopped", 
7 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", 
8 "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" 
9}

HIPAA eligibility and PCI compliance

HIPAA eligibility and PCI compliance varies depending on your selected speech model and whether you use webhooks or persisted transcripts. To determine whether your implementation may be HIPAA eligible or PCI compliant, see the following table.

Transcription engine	Speech model	Transcript destination	HIPAA eligibility	PCI-compliant
Google	Any supported model	Webhooks	Yes	Yes
Google	Any supported model	Persisted Transcript	Yes	No
Deepgram	`nova-2` or `nova-3` monolingual variants	Webhooks	Yes	Yes
Deepgram	`nova-2` or `nova-3` monolingual variants	Persisted Transcript	Yes	No
Deepgram	`nova-3` multilingual	Webhooks or Persisted Transcript	No	No

AI nutrition facts

(information)

AI Nutrition Facts

The Calls Transcriptions subresource and <Transcriptions> TwiML noun use third-party artificial technology and machine learning technologies.

Twilio's AI Nutrition Facts provide an overview of the AI feature you're using, so you can better understand how the AI is working with your data. Real-Time Transcriptions AI qualities are outlined in the following Speech to Text Transcriptions - Programmable Voice Nutrition Facts label. For more information and the glossary regarding the AI Nutrition Facts Label, see Twilio's AI Nutrition Facts.

AI Nutrition Facts

Speech to Text Transcriptions - Programmable Voice, Twilio Video, and Conversational Intelligence

Description: Generate speech to text voice transcriptions (real-time and post-call) in Programmable Voice, Twilio Video, and Conversational Intelligence.
Privacy Ladder Level: N/A
Feature is Optional: Yes
Model Type: Generative and Predictive - Automatic Speech Recognition
Base Model: Deepgram Speech-to-Text, Google Speech-to-Text, Amazon Transcribe
Base Model Trained with Customer Data: No
Customer Data is Shared with Model Vendor: No
Training Data Anonymized: N/A
Data Deletion: Yes
Human in the Loop: Yes
Data Retention: Until the customer deletes
Logging & Auditing: Yes
Guardrails: Yes
Input/Output Consistency: Yes
Other Resources: https://www.twilio.com/docs/conversational-intelligence

Learn more about this label at nutrition-facts.ai