Create a new Transcript for the service

POST /v2/Transcripts

Create a new Transcript for the service

application/x-www-form-urlencoded

Body

  • ServiceSid string Required

    The unique SID identifier of the Service.

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

  • Channel Required

    JSON object describing Media Channel including Source and Participants

  • CustomerKey string

    Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.

  • MediaStartTime string(date-time)

    The date that this Transcript's media was started, given in ISO 8601 format.

Responses

  • 202 application/json

    Accepted

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • 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
    • account_sid string | null

      The unique SID identifier of the Account.

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

    • service_sid string | null

      The unique SID identifier of the Service.

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

    • sid string | null

      A 34 character string that uniquely identifies this Transcript.

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

    • date_created string(date-time) | null

      The date that this Transcript was created, given in ISO 8601 format.

    • date_updated string(date-time) | null

      The date that this Transcript was updated, given in ISO 8601 format.

    • status string

      The Status of this Transcript. One of queued, in-progress, completed, failed or canceled.

      Values are queued, in-progress, completed, failed, or canceled.

    • channel

      Media Channel describing Transcript Source and Participant Mapping

    • data_logging boolean | null

      Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

    • language_code string | null

      The default language code of the audio.

    • customer_key string | null
    • media_start_time string(date-time) | null

      The date that this Transcript's media was started, given in ISO 8601 format.

    • duration integer

      The duration of this Transcript's source

      Default value is 0.

    • url string(uri) | null

      The URL of this resource.

    • redaction boolean | null

      If the transcript has been redacted, a redacted alternative of the transcript will be available.

POST /v2/Transcripts
curl \
 --request POST 'https://intelligence.twilio.com/v2/Transcripts' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Channel=%7B+%22media_properties%22+%3A+%7B+%22media_url%22%3A+%22http%3A%2F%2Ffoobar.test%2FClusterTests%2Fcall1.wav%22%7D%7D&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CustomerKey=aaaaaaaa'
Request examples
{"Channel"=>"{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", "ServiceSid"=>"GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CustomerKey"=>"aaaaaaaa"}
{"Channel"=>"{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", "ServiceSid"=>"GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CustomerKey"=>"aaaaaaaa"}
Response examples (202)
{
  "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media",
    "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences",
    "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults"
  },
  "status": "queued",
  "channel": {
    "media_properties": {
      "media_url": "http://foobar.test/ClusterTests/call1.wav"
    }
  },
  "duration": 0,
  "redaction": true,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "customer_key": "aaaaaaaa",
  "data_logging": false,
  "date_created": "2010-08-31T20:36:28Z",
  "date_updated": "2010-08-31T20:36:28Z",
  "language_code": "en-US",
  "media_start_time": null
}
{
  "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media",
    "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences",
    "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults"
  },
  "status": "queued",
  "channel": {
    "media_properties": {
      "media_url": "http://foobar.test/ClusterTests/call1.wav"
    }
  },
  "duration": 0,
  "redaction": true,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "customer_key": null,
  "data_logging": false,
  "date_created": "2010-08-31T20:36:28Z",
  "date_updated": "2010-08-31T20:36:28Z",
  "language_code": "en-US",
  "media_start_time": null
}