VideoV1Transcriptions
post/v1/Rooms/{RoomSid}/Transcriptions

Request

  • Base URL
    https://video.twilio.com
  • URL
    https://video.twilio.com/v1/Rooms/{RoomSid}/Transcriptions
  • Auth
    HTTP basic

Path parameters

RoomSidstring required

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

Request body application/x-www-form-urlencoded

Configurationobject

A collection of properties that describe transcription behaviour.

Response

Accepted

ttidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Room resource.

room_sidstring nullable

The SID of the transcriptions's room.

source_sidstring nullable

The SID of the transcriptions's associated call.

status'started' | 'stopped' | 'failed'

The status of the transcriptions resource.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

start_timestring date-time nullable

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

end_timestring date-time nullable

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

durationinteger nullable

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

urlstring uri nullable

The absolute URL of the resource.

configurationobject nullable

An JSON object that describes the video layout of the composition in terms of regions. See Specifying Video Layouts for more info.

Changes

    • info

      added the optional property to the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the created enum value from the response property for the response status