Kapitel 5 GET POST

end – Meeting beenden

Der Endpunkt end beendet ein laufendes BigBlueButton-Meeting sofort. Alle Teilnehmenden werden aus der Konferenz entfernt, und wenn die Aufzeichnung aktiviert war, wird die Verarbeitungs-Pipeline für die Aufzeichnung automatisch ausgelöst.

Endpunkt

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/end?<parameter>&checksum=replace-with-checksum

Sowohl GET- als auch POST-Methoden werden unterstützt. Bei Verwendung von POST senden Sie die Parameter als application/x-www-form-urlencoded im Request-Body.

Erforderliche Parameter

Parameter Typ Beschreibung
meetingID String Erforderlich. Die Meeting-ID des zu beendenden Meetings. Muss mit der ID übereinstimmen, die bei der Erstellung des Meetings verwendet wurde.

Optionale Parameter

Parameter Typ Beschreibung
password String Deprecated Das Moderatorpasswort. Dieser Parameter ist seit BigBlueButton 3.0 nicht mehr erforderlich — das checksum allein reicht zur Authentifizierung aus.

Beispielanfrage

POST-Anfrage mit cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/end" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "meetingID=replace-with-meeting-id&checksum=replace-with-checksum"

Beispielantwort

Erfolg

<response>
  <returncode>SUCCESS</returncode>
  <messageKey>sentEndMeetingRequest</messageKey>
  <message>A request to end the meeting was sent. Please wait a few seconds,
    and then use the getMeetingInfo or isMeetingRunning API calls to verify
    that it was ended.</message>
</response>

Fehler — Meeting nicht gefunden

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find a meeting with that meeting ID.</message>
</response>

bbbserver.de Hinweise

bbbserver.de: Der Parameter duration im Aufruf create beendet Meetings auf nichtbbbserver.de automatisch. Wenn Sie ein Meeting nach einer bestimmten Zeit beenden müssen, müssen Sie zum gewünschten Zeitpunkt manuell einen API-Aufruf end senden (zum Beispiel über einen Timer oder cron job in Ihrer Anwendung).

Wichtiges Verhalten

Der Aufruf end ist asynchron. Die Antwort bestätigt, dass die Anfrage empfangen wurde, nicht, dass das Meeting bereits vollständig beendet wurde. Der genaue Zeitpunkt des Herunterfahrens ist offiziell nicht spezifiziert.

Senden Sie den end-API-Aufruf an den Server.

Warten Sie ein paar Sekunden, bis das Meeting beendet wird.

Überprüfen Sie mit getMeetingInfo oder isMeetingRunning, ob das Meeting beendet wurde.

Tipps

Wenn Sie den Parameter meta_endCallbackUrl während create setzen, sendet BigBlueButton einen Callback an Ihre angegebene URL, wenn das Meeting endet. Verwenden Sie dies, um Nachbearbeitungs-Workflows nach dem Meeting automatisch auszulösen.

  • Wenn die Aufzeichnung aktiviert war, beginnt die Aufzeichnungsverarbeitung automatisch nach dem Ende des Meetings.
  • Ein beendetes Meeting kann nicht fortgesetzt werden — Sie müssen ein neues Meeting erstellen.
  • Seit BigBlueButton 3.0 ist der Parameter password nicht mehr erforderlich. Das checksum bietet eine ausreichende Authentifizierung.

Häufig gestellte Fragen

Alle Teilnehmenden werden sofort aus der Konferenz entfernt. Sie sehen eine Benachrichtigung, dass das Meeting von einem Moderator oder Administrator beendet wurde.

Nein. Sobald ein Meeting beendet wurde, kann es nicht fortgesetzt werden. Sie müssen mit dem API-Aufruf create ein neues Meeting erstellen. Sie können dabei auf Wunsch dieselbe meetingID wiederverwenden.

Nein. Seit BigBlueButton 3.0 ist der Parameter password veraltet und nicht mehr erforderlich. Das checksum reicht zur Authentifizierung aus. Ältere Versionen können das Moderatorpasswort noch erfordern.

Der Aufruf end ist asynchron. Obwohl die Antwort in der Regel innerhalb von Millisekunden zurückgegeben wird, kann der tatsächliche Beendigungsprozess einige Sekunden dauern. Der genaue Zeitpunkt ist offiziell nicht spezifiziert. Verwenden Sie getMeetingInfo oder isMeetingRunning zur Überprüfung.

Wenn die Aufzeichnung für das Meeting aktiviert war, wird die Verarbeitungs-Pipeline für die Aufzeichnung automatisch ausgelöst, sobald das Meeting endet. Die Aufzeichnung wird verfügbar, sobald die Verarbeitung abgeschlossen ist, was je nach Länge des Meetings mehrere Minuten dauern kann.