Skip to main content

Get Active Room Information

Endpoint: /room/getActiveRoomInfo

Request Parameters

FieldTypePositionRequiredDescription
room_idstringrootYesThe unique ID of the room.

Example Request:

{
"room_id": "room01"
}

Response

FieldTypePositionDescription
statusbooleanrootIndicates if the request was successful.
msgstringrootResponse message.
roomobject<Room>rootContains room details.

Room

FieldTypeDescription
room_infoobject<Room Info>Details about the room.
participants_infoarray<Participant Info>List of current participants.

Room Info

FieldTypeDescription
room_titlestringTitle of the meeting.
room_idstringUnique room ID.
sidstringRoom unique session ID.
joined_participantsnumberTotal number of users who have joined.
is_runningbooleanIndicates if the room is currently active.
is_recordingbooleanIndicates if recording is in progress.
is_active_rtmpbooleanIndicates if RTMP streaming is active.
creation_timenumberRoom creation time (Unix timestamp).
metadatastringRoom metadata.
webhook_urlstringWebhook URL associated with the room.

Participant Info

FieldTypeDescription
sidstringParticipant unique session ID.
identitystringParticipant user ID.
namestringParticipant name.
statestringParticipant state.
metadatastringParticipant metadata.
joined_atnumberTime the participant joined (Unix timestamp).
versionnumberVersion information.