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
roomobject<room>root

Room

FieldTypeDescription
room_infoobject<room_info>
participants_infoarray<participant_info>Array of current participants

Room Info

FieldTypeDescription
room_titlestringTitle of the meeting
room_idstringRoom Id
sidstringRoom Sid
joined_participantsnumberTotal number of users joined
is_runningbooleanIf the room is active now
is_recordingbooleanIf recording active
is_active_rtmpbooleanIf RTMP active
creation_timenumberRoom creation time in unix format
metadatastringRoom metadata
webhook_urlstringWebhook URL

Participant info

FieldTypeDescription
sidstringParticipant Sid
identitystringParticipant userId
namestringParticipant name
statestringParticipant state
metadatastringParticipant metadata
joined_atnumberParticipant joined time in unix format
versionnumber
permissionobject