Get Started

REST API: Transcriptions

A Transcription instance resource represents a transcription of a recording. The transcription text itself is the result of converting an audio recording to readable text. You generate transcriptions from recordings via the TwiML <Record> verb. The Transcriptions list resource represents the set of all transcriptions generated from recordings in an account.

For convenience, a Transcriptions list resource is also available as a subresource of a Recording instance resource. This resource is scoped to an individual recording, so that you can navigate directly from a recording to its transcriptions.

Note: transcription is a pay feature. If you request that a recording be transcribed, your account will be charged. Additionally, transcription is currently limited to recordings at most two minutes in length. Requesting transcription on longer recordings will return with a failure message.

See the pricing page for our transcription prices.

Transcription Instance Resource

This resource represents an individual text transcription of a recorded call.

Resource URI

/2010-04-01/Accounts/{AccountSid}/Transcriptions/{TranscriptionSid}

By default Twilio will respond with the XML metadata for the Transcription. If you append ".txt" to the end of the Transcription resource's URI Twilio will just return you the transcription text:

/2010-04-01/Accounts/{AccountSid}/Transcriptions/{TranscriptionSid}.txt

Resource Properties

A Transcription resource is represented by the following properties:

Property Description
Sid A 34 character string that uniquely identifies this resource.
DateCreated The date that this resource was created, given in RFC 2822 format.
DateUpdated The date that this resource was last updated, given in RFC 2822 format.
AccountSid The unique id of the Account responsible for this transcription.
Status A string representing the status of the transcription: in-progress, completed or failed.
RecordingSid The unique id of the Recording this Transcription was made of.
Duration The duration of the transcribed audio, in seconds.
TranscriptionText The text content of the transcription.
Price The charge for this transcript in the currency associated with the account. Populated after the transcript is completed. Note, this value may not be immediately available.
PriceUnit The currency in which Price is measured, in ISO 4127 format (e.g. usd, eur, jpy).
Uri The URI for this resource, relative to https://api.twilio.com

HTTP GET

Returns a single Transcription resource representation identified by the given {TranscriptionSid}.

Example

HTTP POST

Not Supported

HTTP PUT

Not Supported

HTTP DELETE

Deletes a transcription from your account.

If successful, returns HTTP 204 (No Content) with no body.

Examples

Transcriptions List Resource

Resource URI

/2010-04-01/Accounts/{AccountSid}/Transcriptions

/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions

HTTP GET

Returns a set of Transcription resource representations that includes paging information.

Example

Just grab the whole list.

HTTP POST

Not Supported

HTTP PUT

Not Supported

HTTP DELETE

Not Supported