Skip to main content

Get active room info

End point: /room/getActiveRoomInfo

FieldTypePositionRequiredDescription
room_idstringrootYesRoom Id

Example:

{
"room_id": "room01"
}

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message
roomobjectroot
room_infoobjectroom
participants_infoobjectroomArray of current participants
room_titlestringroom_infoTitle of the meeting
room_idstringroom_infoRoom Id
sidstringroom_infoRoom Sid
joined_participantsnumberroom_infoTotal number of users joined
is_runningbooleanroom_infoIf the room is active now
is_recordingbooleanroom_infoIf recording active
is_active_rtmpbooleanroom_infoIf RTMP active
creation_timenumberroom_infoRoom creation time in unix format
metadatastringroom_infoRoom metadata
webhook_urlstringroom_infoWebhook URL
sidstringparticipants_infoParticipant Sid
identitystringparticipants_infoParticipant userId
statestringparticipants_infoParticipant state
metadatastringparticipants_infoParticipant metadata
joined_atnumberparticipants_infoParticipant joined time in unix format
versionnumberparticipants_info
permissionobjectparticipants_info