Skip to main content

Fetch Past Rooms Information

Endpoint: /room/fetchPastRooms

Request Parameters

FieldTypeRequiredDescription
room_idsarrayYesArray of room IDs to query.
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 results data.

Result

FieldTypeDescription
total_roomsnumberTotal number of rooms found for the query.
fromnumberStarting index for the returned records.
limitnumberNumber of records returned.
order_bystringSort order used for the records.
rooms_listArray<Past Room Info>List of past room records.

Past Room Info

FieldTypeDescription
room_titlestringTitle of the room.
room_idstringUnique identifier for the room.
room_sidstringSID of the room.
joined_participantsnumberNumber of participants who joined (may not be exact; use analytics for detailed information).
webhook_urlstringWebhook URL associated with the room.
createdstringRoom creation time.
endedstringRoom end time.
analytics_file_idstringAnalytics file identifier, if available.