Skip to main content

Fetch Recordings

Endpoint: /recording/fetch

Request Parameters

FieldTypeRequiredDescription
room_idsarrayYesArray of room IDs to fetch recordings for.
fromnumberNoStarting index for records. Default is 0.
limitnumberNoMaximum number of records to return. Default is 20.
order_bystringNoSort order: DESC or ASC. Default is DESC.

Example Request:

{
"room_ids": ["room01"],
"from": 0,
"limit": 20,
"order_by": "DESC"
}

Response

FieldTypePositionDescription
statusbooleanrootIndicates if the request was successful.
msgstringrootResponse message.
resultobjectrootContains the recordings data.

Result

FieldTypeDescription
total_recordingsnumberTotal number of recordings found.
fromnumberStarting index for the returned records.
limitnumberNumber of records returned.
order_bystringSort order used for the records.
recordings_listArray<Recording Info>List of recording records.

Recording Info

FieldTypeDescription
record_idstringUnique identifier for the recording.
room_idstringID of the room associated with the recording.
room_sidstringSID of the room.
file_pathstringPath to the recording file.
file_sizenumberSize of the recording file in bytes.
creation_timenumberRecording creation time (Unix timestamp).
room_creation_timenumberRoom creation time (Unix timestamp).