Create room transcriptions

POST /v1/Rooms/{RoomSid}/Transcriptions
Account sid auth token

transcriptions in video rooms

Path parameters

  • RoomSid string Required

    The SID of the room new transcriptions resource to be created.

application/x-www-form-urlencoded

Body

  • Configuration object

    A collection of properties that describe transcription behaviour.

Responses

  • 202 application/json

    Accepted

    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
    • ttid string | null

      The unique string that we created to identify the transcriptions resource.

    • account_sid string | null

      The SID of the Account that created the Room resource.

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

    • room_sid string | null

      The SID of the transcriptions's room.

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

    • status string

      The status of the transcriptions resource.

      Values are started, stopped, or failed.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • start_time string(date-time) | null

      The time of transcriptions connected to the room in ISO 8601 format.

    • end_time string(date-time) | null

      The time when the transcriptions disconnected from the room in ISO 8601 format.

    • duration integer | null

      The duration in seconds that the transcriptions were connected. Populated only after the transcriptions is stopped.

    • url string(uri) | null

      The absolute URL of the resource.

    • configuration object | null

      An JSON object that describes the video layout of the composition in terms of regions. See Specifying Video Layouts for more info.
POST /v1/Rooms/{RoomSid}/Transcriptions 
curl \
 --request POST 'https://video.twilio.com/v1/Rooms/{RoomSid}/Transcriptions' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Configuration=%7B%22LanguageCode%22%3A+%22EN-us%22%2C+%22ProfanityFilter%22%3A+true%7D'
Request example 
{"Configuration"=>"{\"LanguageCode\": \"EN-us\", \"ProfanityFilter\": true}"}
Response examples (202) 
{
  "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/video_extension_2c70be23-4788-423d-9351-df6705efa035",
  "ttid": "video_extension_2c70be23-4788-423d-9351-df6705efa035",
  "status": "started",
  "duration": null,
  "end_time": null,
  "identity": "transcriptions",
  "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "start_time": "2015-07-30T20:00:00Z",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "configuration": {
    "languageCode": "en-US"
  }
}