Api20100401CallTranscription

Create a Transcription

Changed on

Create a Transcription

post/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that created this Transcription resource.

CallSidstring required

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

Request body application/x-www-form-urlencoded

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.

Track'inbound_track' | 'outbound_track' | 'both_tracks'

One of inbound_track, outbound_track, both_tracks.

StatusCallbackUrlstring uri

Absolute URL of the status callback.

StatusCallbackMethod'GET' | 'POST' http-method

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

InboundTrackLabelstring

Friendly name given to the Inbound Track

OutboundTrackLabelstring

Friendly name given to the Outbound Track

PartialResultsboolean

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

LanguageCodestring

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

TranscriptionEnginestring

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

ProfanityFilterboolean

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

SpeechModelstring

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

Hintsstring

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

EnableAutomaticPunctuationboolean

The provider will add punctuation to recognition result

IntelligenceServicestring

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

ConversationConfigurationstring

The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service

ConversationIdstring

The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service

TranscriptionConfigurationIdstring

The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go.

EnableProviderDataboolean

Whether the callback includes raw provider data.

Response

OK

sidstring nullable

The SID of the Transcription resource.

account_sidstring nullable

The SID of the Account that created this Transcription resource.

call_sidstring nullable

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

namestring nullable

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

status'in-progress' | 'stopped'

The status - one of stopped, in-flight

date_updatedstring date-time-rfc-2822 nullable

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

uristring nullable

Changes