Sign in

Returns a single Recording resource identified by a Recording SID.

get/v1/Recordings/{Sid}

Path parameters

Sidstring required

The SID of the Recording resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Recording resource.

status'processing' | 'completed' | 'deleted' | 'failed'
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 Recording 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'
durationinteger nullable

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

container_format'mka' | 'mkv'
codec'VP8' | 'H264' | 'OPUS' | 'PCMU'
{"stackTrail":"components:schemas:video.v1.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.

status_callbackstring uri nullable

The URL called using the status_callback_method to send status information on every recording event.

status_callback_method'HEAD' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' http-method nullable

The HTTP method used to call status_callback. Can be: POST or GET, defaults to POST.

linksobject nullable

The URLs of related resources.

Changes