Kapitel 8 GET POST

isMeetingRunning – Meeting-Status prüfen

Der Endpunkt isMeetingRunning prüft, ob ein bestimmtes Meeting auf dem BigBlueButton-Server derzeit aktiv ist. Er gibt einen einfachen booleschen Wert zurück und ist damit der leichtgewichtigste Monitoring-Aufruf in der API.

Endpunkt

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Dieser Endpunkt gibt immer den Return-Code SUCCESS zurück, selbst wenn die angegebene Meeting-ID nicht existiert. In diesem Fall ist der Wert running einfach false.

Erforderliche Parameter

Parameter Typ Erforderlich Beschreibung
meetingID String Ja Die Meeting-ID des Meetings, das Sie prüfen möchten.

Beispielanfrage

https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Beispielantwort

<response>
  <returncode>SUCCESS</returncode>
  <running>true</running>
</response>

Antwortfelder

Feld Typ Beschreibung
returncode String Für diesen Endpunkt immer SUCCESS, unabhängig davon, ob das Meeting existiert.
running Boolean true, wenn das Meeting derzeit läuft, false, wenn es nicht läuft oder die Meeting-ID unbekannt ist.

Wann gilt ein Meeting als laufend?

Ein Meeting gilt als laufend, sobald mindestens ein Teilnehmer beigetreten ist. Ein frisch erstelltes Meeting ohne Teilnehmer gibt running als false zurück, obwohl es auf dem Server existiert.

Rufen Sie create auf, um ein neues Meeting auf dem Server einzurichten.

An diesem Punkt gibt isMeetingRunning false zurück — noch ist niemand beigetreten.

Ein Teilnehmer tritt über join bei. Das Meeting läuft jetzt.

isMeetingRunning gibt jetzt true zurück.

Hinweise für bbbserver.de-Benutzer

Auf verwalteten Instanzen von bbbserver.de wird die API-Prüfsumme automatisch berechnet, wenn Sie die integrierten API-Tools verwenden. Sie müssen sie nicht manuell berechnen.

Tipps und Best Practices

Obwohl isMeetingRunning für einfaches Status-Polling geeignet ist, sollten Sie für effizienteres Echtzeit-Monitoring Webhooks in Betracht ziehen. Häufiges Polling dieses Endpunkts erzeugt unnötige Last auf dem Server.

Verlassen Sie sich für einen detaillierten Meeting-Status nicht allein auf isMeetingRunning. Verwenden Sie stattdessen getMeetingInfo, wenn Sie Teilnehmerzahlen, Aufzeichnungsstatus oder andere Metadaten benötigen.

  • Verwenden Sie diesen Endpunkt für leichtgewichtige Health-Checks oder einfache Dashboards, die nur wissen müssen, ob ein Meeting aktiv ist.
  • Kombinieren Sie es mit getMeetings, wenn Sie mehrere Meetings gleichzeitig überwachen müssen — ein einzelner Aufruf von getMeetings ist effizienter als viele einzelne Aufrufe von isMeetingRunning.
  • Halten Sie Ihr Abfrageintervall angemessen (z. B. alle 30 bis 60 Sekunden), um den Server nicht unnötig zu belasten.

Häufig gestellte Fragen

Der Endpunkt gibt weiterhin SUCCESS zurück, wobei running auf false gesetzt ist. Er erzeugt keinen Fehler für unbekannte Meeting-IDs.

Nein. Ein Meeting gilt erst dann als laufend, wenn mindestens ein Teilnehmer beigetreten ist. Ein Meeting, das erstellt wurde, aber keine Teilnehmer hat, gibt running als false zurück.

Für einfache Statusprüfungen ja. Für eine echtzeitbasierte, ereignisgesteuerte Überwachung sind Webhooks jedoch die effizientere Alternative, da sie Aktualisierungen an Ihre Anwendung senden, anstatt wiederholte Abfragen zu erfordern.

isMeetingRunning gibt nur einen booleschen Wert zurück, der angibt, ob das Meeting aktiv ist. getMeetingInfo gibt umfassende Details zurück, einschließlich Teilnehmerlisten, Aufzeichnungsstatus, Metadaten und mehr. Verwenden Sie isMeetingRunning, wenn Sie nur eine schnelle Ja-oder-Nein-Antwort benötigen.

Ja. Die BigBlueButton-API akzeptiert für isMeetingRunning sowohl GET- als auch POST-Anfragen. Die Parameter und die Antwort sind unabhängig von der verwendeten HTTP-Methode identisch.