Create a Transcription

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json
Account sid auth token

Create a Transcription

Path parameters

  • AccountSid string Required

    The SID of the Account that created this Transcription resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • CallSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • Name string

    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 string

    Values are inbound_track, outbound_track, or both_tracks.

  • StatusCallbackUrl string(uri)

    Absolute URL of the status callback.

  • StatusCallbackMethod string(http-method)

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

    Values are GET or POST.

  • InboundTrackLabel string

    Friendly name given to the Inbound Track

  • OutboundTrackLabel string

    Friendly name given to the Outbound Track

  • PartialResults boolean

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

  • LanguageCode string

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

  • TranscriptionEngine string

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

  • ProfanityFilter boolean

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

  • SpeechModel string

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

  • Hints string

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

  • EnableAutomaticPunctuation boolean

    The provider will add punctuation to recognition result

  • IntelligenceService string

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

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The SID of the Transcription resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GT[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created this Transcription resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • call_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • name string | null

      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 string

      The status - one of stopped, in-flight

      Values are in-progress or stopped.

    • date_updated string(date-time-rfc-2822) | null

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

    • uri string | null
POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json 
curl \
 --request POST 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'value=%7B%7D'
Request examples 
{"value"=>{}}
{"Name"=>"myName", "Hints"=>"this is a hint", "Track"=>"inbound_track", "SpeechModel"=>"long", "LanguageCode"=>"en-US", "PartialResults"=>false, "ProfanityFilter"=>false, "InboundTrackLabel"=>"inbound_track_label", "StatusCallbackUrl"=>"http://statuscallback.com", "OutboundTrackLabel"=>"outbound_track_label", "IntelligenceService"=>"GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "TranscriptionEngine"=>"google", "StatusCallbackMethod"=>"PUT", "EnableAutomaticPunctuation"=>true}
Response examples (200) 
{
  "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "name": null,
  "status": "in-progress",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000"
}
{
  "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "name": "myName",
  "status": "in-progress",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000"
}