Saltar al contenido principal

Obtener Información de una Sala Activa

Punto final: /room/getActiveRoomInfo

Este punto final recupera información detallada y en tiempo real sobre una sala activa específica. Mientras que isRoomActive simplemente le indica si una sala está en funcionamiento, esta API proporciona una instantánea completa de la sesión, incluido su estado actual, una lista de todos los participantes y sus detalles individuales.

Esto es útil para crear paneles de administración o herramientas de moderación donde necesite monitorear reuniones en vivo. Puede ver quién está en la sala, cuándo se unieron y otros metadatos asociados tanto con la sala como con los participantes.

Parámetros de la Solicitud

CampoTipoPosiciónRequeridoDescripción
room_idstringraízEl ID único de la sala.

Ejemplo de Solicitud:

{
"room_id": "sala01"
}

Respuesta

CampoTipoPosiciónDescripción
statusbooleanraízIndica si la solicitud fue exitosa.
msgstringraízMensaje de respuesta.
status_codestringraízCódigo de estado de la respuesta.
roomobject<Sala>raízContiene los detalles de la sala.

Sala

CampoTipoDescripción
room_infoobject<Información de la Sala>Detalles sobre la sala.
participants_infoarray<Información del Participante>Lista de los participantes actuales.

Información de la Sala

CampoTipoDescripción
room_titlestringTítulo de la reunión.
room_idstringID único de la sala.
sidstringID de sesión único de la sala (SID).
joined_participantsnumberNúmero total de usuarios que se han unido.
is_runningbooleanIndica si la sala se encuentra actualmente activa.
is_recordingbooleanIndica si la grabación está en curso.
is_active_rtmpbooleanIndica si la transmisión RTMP está activa.
creation_timenumberFecha y hora de creación de la sala (marca de tiempo Unix).
metadatastringMetadatos de la sala.
webhook_urlstringURL del webhook asociada a la sala.

Información del Participante

CampoTipoDescripción
sidstringID de sesión único del participante (SID).
identitystringID de usuario del participante.
namestringNombre del participante.
statestringEstado del participante.
metadatastringMetadatos del participante.
joined_atnumberFecha y hora en que se unió el participante (marca de tiempo Unix).
versionnumberInformación de la versión.