Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

RealtimeTranscription Resource


(warning)

Legal Notice and Public Beta

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(link takes you to an external page).

Real-Time Transcriptions is not PCI compliant or a HIPAA Eligible Service and should not be used in Voice Intelligence workflows that are subject to HIPAA or PCI.

Real-Time Transcription is currently available as a Public Beta product and information contained in this document is subject to change. This means that some of the features are not yet implemented and others may be changed before the product is declared as Generally Available. Public Beta products are not covered by a Twilio Service Level Agreement.

The RealtimeTranscription resource represents a live audio transcription during a live call. You can start and stop a RealtimeTranscription on any in-progress call via API or via the <Transcription> TwiML Noun.

To start a Real-Time Transcription on a live call, you create a RealtimeTranscription resource.

To stop the Real-Time Transcription, you update the RealtimeTranscription resource's status.


RealtimeTranscription Properties

realtimetranscription-properties page anchor
Property nameTypePIIDescription
sidSID<GT>
Not PII

The SID of the Transcription resource.

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

account_sidSID<AC>

The SID of the Account that created this Transcription resource.

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

call_sidSID<CA>

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

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

namestring

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>

The status - one of stopped, in-flight

Possible values:
in-progressstopped

date_updatedstring<date-time-rfc-2822>

The date and time in GMT that this resource was last updated, specified in RFC 2822(link takes you to an external page) format.


uristring

Start a Real-Time Transcription

start-a-real-time-transcription page anchor
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json

Path parameters

path-parameters page anchor
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
Property nameTypeRequiredPIIDescription
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.


Trackenum<string>Optional

One of inbound_track, outbound_track, both_tracks.

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

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 send to the customer


LanguageCodestringOptional

Language code used by the transcription engine, specified in BCP-47(link takes you to an external page) format


TranscriptionEnginestringOptional

Definition of the transcription engine to be used, between 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, between 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 adds punctuation to recognition result hypotheses


Parameter1.NamestringOptional

Parameter name


Parameter1.ValuestringOptional

Parameter value


Parameter2.NamestringOptional

Parameter name


Parameter2.ValuestringOptional

Parameter value


Parameter3.NamestringOptional

Parameter name


Parameter3.ValuestringOptional

Parameter value


Parameter4.NamestringOptional

Parameter name


Parameter4.ValuestringOptional

Parameter value


Parameter5.NamestringOptional

Parameter name


Parameter5.ValuestringOptional

Parameter value


Parameter6.NamestringOptional

Parameter name


Parameter6.ValuestringOptional

Parameter value


Parameter7.NamestringOptional

Parameter name


Parameter7.ValuestringOptional

Parameter value


Parameter8.NamestringOptional

Parameter name


Parameter8.ValuestringOptional

Parameter value


Parameter9.NamestringOptional

Parameter name


Parameter9.ValuestringOptional

Parameter value


Parameter10.NamestringOptional

Parameter name


Parameter10.ValuestringOptional

Parameter value


Parameter11.NamestringOptional

Parameter name


Parameter11.ValuestringOptional

Parameter value


Parameter12.NamestringOptional

Parameter name


Parameter12.ValuestringOptional

Parameter value


Parameter13.NamestringOptional

Parameter name


Parameter13.ValuestringOptional

Parameter value


Parameter14.NamestringOptional

Parameter name


Parameter14.ValuestringOptional

Parameter value


Parameter15.NamestringOptional

Parameter name


Parameter15.ValuestringOptional

Parameter value


Parameter16.NamestringOptional

Parameter name


Parameter16.ValuestringOptional

Parameter value


Parameter17.NamestringOptional

Parameter name


Parameter17.ValuestringOptional

Parameter value


Parameter18.NamestringOptional

Parameter name


Parameter18.ValuestringOptional

Parameter value


Parameter19.NamestringOptional

Parameter name


Parameter19.ValuestringOptional

Parameter value


Parameter20.NamestringOptional

Parameter name


Parameter20.ValuestringOptional

Parameter value


Parameter21.NamestringOptional

Parameter name


Parameter21.ValuestringOptional

Parameter value


Parameter22.NamestringOptional

Parameter name


Parameter22.ValuestringOptional

Parameter value


Parameter23.NamestringOptional

Parameter name


Parameter23.ValuestringOptional

Parameter value


Parameter24.NamestringOptional

Parameter name


Parameter24.ValuestringOptional

Parameter value


Parameter25.NamestringOptional

Parameter name


Parameter25.ValuestringOptional

Parameter value


Parameter26.NamestringOptional

Parameter name


Parameter26.ValuestringOptional

Parameter value


Parameter27.NamestringOptional

Parameter name


Parameter27.ValuestringOptional

Parameter value


Parameter28.NamestringOptional

Parameter name


Parameter28.ValuestringOptional

Parameter value


Parameter29.NamestringOptional

Parameter name


Parameter29.ValuestringOptional

Parameter value


Parameter30.NamestringOptional

Parameter name


Parameter30.ValuestringOptional

Parameter value


Parameter31.NamestringOptional

Parameter name


Parameter31.ValuestringOptional

Parameter value


Parameter32.NamestringOptional

Parameter name


Parameter32.ValuestringOptional

Parameter value


Parameter33.NamestringOptional

Parameter name


Parameter33.ValuestringOptional

Parameter value


Parameter34.NamestringOptional

Parameter name


Parameter34.ValuestringOptional

Parameter value


Parameter35.NamestringOptional

Parameter name


Parameter35.ValuestringOptional

Parameter value


Parameter36.NamestringOptional

Parameter name


Parameter36.ValuestringOptional

Parameter value


Parameter37.NamestringOptional

Parameter name


Parameter37.ValuestringOptional

Parameter value


Parameter38.NamestringOptional

Parameter name


Parameter38.ValuestringOptional

Parameter value


Parameter39.NamestringOptional

Parameter name


Parameter39.ValuestringOptional

Parameter value


Parameter40.NamestringOptional

Parameter name


Parameter40.ValuestringOptional

Parameter value


Parameter41.NamestringOptional

Parameter name


Parameter41.ValuestringOptional

Parameter value


Parameter42.NamestringOptional

Parameter name


Parameter42.ValuestringOptional

Parameter value


Parameter43.NamestringOptional

Parameter name


Parameter43.ValuestringOptional

Parameter value


Parameter44.NamestringOptional

Parameter name


Parameter44.ValuestringOptional

Parameter value


Parameter45.NamestringOptional

Parameter name


Parameter45.ValuestringOptional

Parameter value


Parameter46.NamestringOptional

Parameter name


Parameter46.ValuestringOptional

Parameter value


Parameter47.NamestringOptional

Parameter name


Parameter47.ValuestringOptional

Parameter value


Parameter48.NamestringOptional

Parameter name


Parameter48.ValuestringOptional

Parameter value


Parameter49.NamestringOptional

Parameter name


Parameter49.ValuestringOptional

Parameter value


Parameter50.NamestringOptional

Parameter name


Parameter50.ValuestringOptional

Parameter value


Parameter51.NamestringOptional

Parameter name


Parameter51.ValuestringOptional

Parameter value


Parameter52.NamestringOptional

Parameter name


Parameter52.ValuestringOptional

Parameter value


Parameter53.NamestringOptional

Parameter name


Parameter53.ValuestringOptional

Parameter value


Parameter54.NamestringOptional

Parameter name


Parameter54.ValuestringOptional

Parameter value


Parameter55.NamestringOptional

Parameter name


Parameter55.ValuestringOptional

Parameter value


Parameter56.NamestringOptional

Parameter name


Parameter56.ValuestringOptional

Parameter value


Parameter57.NamestringOptional

Parameter name


Parameter57.ValuestringOptional

Parameter value


Parameter58.NamestringOptional

Parameter name


Parameter58.ValuestringOptional

Parameter value


Parameter59.NamestringOptional

Parameter name


Parameter59.ValuestringOptional

Parameter value


Parameter60.NamestringOptional

Parameter name


Parameter60.ValuestringOptional

Parameter value


Parameter61.NamestringOptional

Parameter name


Parameter61.ValuestringOptional

Parameter value


Parameter62.NamestringOptional

Parameter name


Parameter62.ValuestringOptional

Parameter value


Parameter63.NamestringOptional

Parameter name


Parameter63.ValuestringOptional

Parameter value


Parameter64.NamestringOptional

Parameter name


Parameter64.ValuestringOptional

Parameter value


Parameter65.NamestringOptional

Parameter name


Parameter65.ValuestringOptional

Parameter value


Parameter66.NamestringOptional

Parameter name


Parameter66.ValuestringOptional

Parameter value


Parameter67.NamestringOptional

Parameter name


Parameter67.ValuestringOptional

Parameter value


Parameter68.NamestringOptional

Parameter name


Parameter68.ValuestringOptional

Parameter value


Parameter69.NamestringOptional

Parameter name


Parameter69.ValuestringOptional

Parameter value


Parameter70.NamestringOptional

Parameter name


Parameter70.ValuestringOptional

Parameter value


Parameter71.NamestringOptional

Parameter name


Parameter71.ValuestringOptional

Parameter value


Parameter72.NamestringOptional

Parameter name


Parameter72.ValuestringOptional

Parameter value


Parameter73.NamestringOptional

Parameter name


Parameter73.ValuestringOptional

Parameter value


Parameter74.NamestringOptional

Parameter name


Parameter74.ValuestringOptional

Parameter value


Parameter75.NamestringOptional

Parameter name


Parameter75.ValuestringOptional

Parameter value


Parameter76.NamestringOptional

Parameter name


Parameter76.ValuestringOptional

Parameter value


Parameter77.NamestringOptional

Parameter name


Parameter77.ValuestringOptional

Parameter value


Parameter78.NamestringOptional

Parameter name


Parameter78.ValuestringOptional

Parameter value


Parameter79.NamestringOptional

Parameter name


Parameter79.ValuestringOptional

Parameter value


Parameter80.NamestringOptional

Parameter name


Parameter80.ValuestringOptional

Parameter value


Parameter81.NamestringOptional

Parameter name


Parameter81.ValuestringOptional

Parameter value


Parameter82.NamestringOptional

Parameter name


Parameter82.ValuestringOptional

Parameter value


Parameter83.NamestringOptional

Parameter name


Parameter83.ValuestringOptional

Parameter value


Parameter84.NamestringOptional

Parameter name


Parameter84.ValuestringOptional

Parameter value


Parameter85.NamestringOptional

Parameter name


Parameter85.ValuestringOptional

Parameter value


Parameter86.NamestringOptional

Parameter name


Parameter86.ValuestringOptional

Parameter value


Parameter87.NamestringOptional

Parameter name


Parameter87.ValuestringOptional

Parameter value


Parameter88.NamestringOptional

Parameter name


Parameter88.ValuestringOptional

Parameter value


Parameter89.NamestringOptional

Parameter name


Parameter89.ValuestringOptional

Parameter value


Parameter90.NamestringOptional

Parameter name


Parameter90.ValuestringOptional

Parameter value


Parameter91.NamestringOptional

Parameter name


Parameter91.ValuestringOptional

Parameter value


Parameter92.NamestringOptional

Parameter name


Parameter92.ValuestringOptional

Parameter value


Parameter93.NamestringOptional

Parameter name


Parameter93.ValuestringOptional

Parameter value


Parameter94.NamestringOptional

Parameter name


Parameter94.ValuestringOptional

Parameter value


Parameter95.NamestringOptional

Parameter name


Parameter95.ValuestringOptional

Parameter value


Parameter96.NamestringOptional

Parameter name


Parameter96.ValuestringOptional

Parameter value


Parameter97.NamestringOptional

Parameter name


Parameter97.ValuestringOptional

Parameter value


Parameter98.NamestringOptional

Parameter name


Parameter98.ValuestringOptional

Parameter value


Parameter99.NamestringOptional

Parameter name


Parameter99.ValuestringOptional

Parameter value

Create a RealtimeTranscription

create-a-realtimetranscription page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function createRealtimeTranscription() {
_18
const transcription = await client
_18
.calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18
.transcriptions.create();
_18
_18
console.log(transcription.sid);
_18
}
_18
_18
createRealtimeTranscription();

Output

_10
{
_10
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"name": null,
_10
"status": "in-progress",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_10
}


Stop a Real-Time Transcription

stop-a-real-time-transcription page anchor
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json

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

Sidstringrequired

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

Property nameTypeRequiredPIIDescription
Statusenum<string>required

The status. Must have the value stopped

Possible values:
stopped

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

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

Stop a Real-Time Transcription

stop-a-real-time-transcription-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
_19
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19
const authToken = process.env.TWILIO_AUTH_TOKEN;
_19
const client = twilio(accountSid, authToken);
_19
_19
async function updateRealtimeTranscription() {
_19
const transcription = await client
_19
.calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19
.transcriptions("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19
.update({ status: "stopped" });
_19
_19
console.log(transcription.sid);
_19
}
_19
_19
updateRealtimeTranscription();

Output

_10
{
_10
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"name": null,
_10
"status": "stopped",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_10
}


(information)

AI Nutrition Facts

Real-Time Transcriptions, including <Transcriptions> TwiML noun and API, uses third-party artificial technology and machine learning technologies.

Twilio's AI Nutrition Facts(link takes you to an external page) 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, please refer to Twilio's AI Nutrition Facts page(link takes you to an external page).

AI Nutrition Facts

Speech to Text Transcriptions - Programmable Voice and Voice Intelligence

Description
Generate speech to text voice transcriptions (real-time and post-call) in Programmable Voice and Voice Intelligence.
Privacy Ladder Level
N/A
Feature is Optional
Yes
Model Type
Generative and Predictive - Automatic Speech Recognition
Base Model
Google Speech-to-Text, Amazon Transcribe

Trust Ingredients

Base Model Trained with Customer Data
No

Voice Intelligence and Programmable Voice only use the default Base Model provided by the Model Vendor. The Base Model is not trained using customer data.

Customer Data is Shared with Model Vendor
No

Voice Intelligence and Programmable Voice only use the default Base Model provided by the Model Vendor. The Base Model is not trained using customer data.

Training Data Anonymized
N/A

Base Model is not trained using any customer data.

Data Deletion
Yes

Transcriptions are deleted by the customer using the Voice Intelligence API or when a customer account is deprovisioned.

Human in the Loop
Yes

The customer views output in the Voice Intelligence API or Transcript Viewer.

Data Retention
Until the customer deletes

Compliance

Logging & Auditing
Yes

The customer can listen to the input (recording) and view the output (transcript).

Guardrails
Yes

The customer can listen to the input (recording) and view the output (transcript).

Input/Output Consistency
Yes

The customer is responsible for human review.

Other Resources
https://www.twilio.com/docs/voice/intelligence

Rate this page: