Skip to main content

Fetch past rooms info

End point: /room/fetchPastRooms

FieldTypeRequiredDescription
room_idsarrayYesArray of room Ids'
fromnumberNoFrom point. Default 0
limitnumberNoLimit of records. Default 20
order_bystringNoOrdering DESC or ASC. Default: DESC

Example:

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

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message
resultobject<result>root

Result

FieldTypeDescription
total_roomsnumberTotal number of rooms for the query
fromnumberRequested from point
limitnumberRequested limit of records
order_bystringRecord order
rooms_listArray<past-room-info>

Past Room info

FieldTypeDescription
room_titlestringRoom title
room_idstringRoom Id
room_sidstringRoom Sid
joined_participantsnumberNumber of participants joined (may not be accurate, use analytics to get more details)
webhook_urlstringWebhook url
createdstringRoom created time
endedstringRoom ended time
analytics_file_idstringAnalytics file id (if any)