Stai visualizzando la documentazione API per BigBlueButton 3.x. La versione attuale è BigBlueButton 4.x. Stai pianificando un aggiornamento? La guida alla migrazione elenca tutte le modifiche necessarie alle tue chiamate API.
isMeetingRunning – Controlla stato della riunione
L'endpoint isMeetingRunning verifica se una specifica riunione è attualmente attiva sul server BigBlueButton. Restituisce un semplice valore booleano, rendendolo la chiamata di monitoraggio più leggera disponibile nell'API.
Endpoint
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum Per ogni richiesta valida, questo endpoint restituisce un codice di ritorno SUCCESS, anche se l'ID riunione fornito non esiste. In tal caso, il valore di running è semplicemente false.
Parametri obbligatori
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
meetingID | String | Sì | L'ID della riunione che vuoi verificare. |
Esempio di richiesta
https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum Risposta di esempio
<response>
<returncode>SUCCESS</returncode>
<running>true</running>
</response> Campi della risposta
| Campo | Tipo | Descrizione |
|---|---|---|
returncode | String | SUCCESS per ogni richiesta valida, indipendentemente dall'esistenza della riunione. |
running | Boolean | true se la riunione è attualmente in esecuzione, false se non è in esecuzione o se l'ID riunione è sconosciuto. |
Quando una riunione è considerata in esecuzione?
Una riunione è considerata in esecuzione una volta che almeno un partecipante si è collegato. Una riunione appena creata senza partecipanti restituirà running come false, anche se esiste sul server.
Chiama create per impostare una nuova riunione sul server.
A questo punto, isMeetingRunning restituisce false — non si è ancora unito nessuno.
Un partecipante si unisce tramite join. La riunione è ora in esecuzione.
isMeetingRunning ora restituisce true.
Suggerimenti e buone pratiche
Sebbene isMeetingRunning sia adatto per un semplice polling dello stato, valuta l'uso dei webhook per un monitoraggio in tempo reale più efficiente. Interrogare questo endpoint ad alta frequenza aggiunge carico inutile al server.
Non fare affidamento solo su isMeetingRunning per uno stato dettagliato della riunione. Usa invece getMeetingInfo se hai bisogno del numero di partecipanti, dello stato della registrazione o di altri metadati.
- Usa questo endpoint per controlli leggeri dello stato di salute o semplici dashboard che devono solo sapere se una riunione è attiva.
- Combinalo con
getMeetingsse devi monitorare più riunioni contemporaneamente — una singola chiamatagetMeetingsè più efficiente di molte chiamate individualiisMeetingRunning. - Mantieni ragionevole il tuo intervallo di polling (ad esempio ogni 30-60 secondi) per evitare di imporre un carico inutile al server.
Domande frequenti
SUCCESS con running impostato su false. Non produce un errore per ID riunione sconosciuti.false.isMeetingRunning restituisce solo un booleano che indica se la riunione è attiva. getMeetingInfo restituisce dettagli completi, inclusi elenchi dei partecipanti, stato della registrazione, metadati e altro. Usa isMeetingRunning quando ti serve solo una risposta rapida sì o no.BigBlueButton accetta sia richieste GET sia POST per isMeetingRunning. I parametri e la risposta sono identici indipendentemente dal metodo HTTP usato.