Sign in
VideoV1RoomRecording

get/v1/Rooms/{RoomSid}/Recordings/{Sid}

Path parameters

RoomSidstring required

The SID of the Room resource with the recording to fetch.

Sidstring required

The SID of the RoomRecording resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the RoomRecording resource.

status'processing' | 'completed' | 'deleted' | 'failed'

The status of the recording. Can be: processing, completed, or deleted. processing indicates the Recording is still being captured. completed indicates the Recording has been captured and is now available for download. deleted means the recording media has been deleted from the system, but its metadata is still available for historical purposes.

date_createdstring date-time nullable

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

sidstring nullable

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

source_sidstring nullable

The SID of the recording source. For a Room Recording, this value is a track_sid.

sizeinteger nullable

The size of the recorded track in bytes.

urlstring uri nullable

The absolute URL of the resource.

type'audio' | 'video' | 'data'

The recording's media type. Can be: audio or video.

durationinteger nullable

The duration of the recording rounded to the nearest second. Sub-second duration tracks have a duration of 1 second

container_format'mka' | 'mkv'
codec'VP8' | 'H264' | 'OPUS' | 'PCMU'

The codec used for the recording. Can be: VP8 or H264.

{"stackTrail":"components:schemas:video.v1.room.room_recording:properties:grouping_sids","oasType":"schema","type":"unknown","description":"A list of SIDs related to the Recording. Includes the `room_sid` and `participant_sid`.","nullable":true}
track_namestring nullable

The name that was given to the source track of the recording. If no name is given, the source_sid is used.

offsetinteger nullable

The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room.

media_external_locationstring uri nullable

The URL of the media file associated with the recording when stored externally. See External S3 Recordings for more details.

room_sidstring nullable

The SID of the Room resource the recording is associated with.

linksobject nullable

The URLs of related resources.