Sie sehen die API-Dokumentation für BigBlueButton 3.x. Die aktuelle Version ist BigBlueButton 4.x. Planen Sie ein Upgrade? Der Migrationsleitfaden listet alle erforderlichen Änderungen an Ihren API-Aufrufen auf.
bbbserver.de IntegrationAPI
Die IntegrationAPI auf bbbserver.de ist ein Proxy, der die standardmäßige BigBlueButton-API spiegelt und dabei Konferenzen im Hintergrund auf mehrere Server mit ausreichender Kapazität verteilt.
bbbserver.de ist eine EU-basierte Premium-Hosting-Plattform für BigBlueButton mit Servern in der EU. Externe Anwendungen verbinden sich über die bekannte BBB-API und verhalten sich so, als würden sie mit einem einzigen Server sprechen.
Wo Sie API-URL und Shared Secret finden
Ihre API-URL und shared secret finden Sie im bbbserver-Administrationsbereich unter Integrationen & API → Integrations-API. Dort lässt sich auch IntegrationAPI aktivieren oder deaktivieren.
Sie benötigen keinen Shell-Zugriff oder bbb-conf-Befehle, um Anmeldedaten abzurufen, wenn Sie bbbserver.de verwenden.
Plugin Kompatibilität
Die folgenden Plattformen funktionieren sofort. In den meisten Fällen müssen Sie nur die API-URL und das shared secret in die standardmäßige BigBlueButton-Integration eintragen.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Unterschiede zur Standard-API
Die IntegrationAPI spiegelt die standardmäßige BBB-API weitgehend, aber einige Verhaltensweisen auf bbbserver.de unterscheiden sich deutlich genug, dass sie bei der Integration ausdrücklich verstanden werden sollten.
Kapazitätsreservierung
Wenn Sie eine Konferenz über die IntegrationAPI erstellen, muss bbbserver.de sie einem Backend-Server mit genügend verbleibenden Ressourcen zuweisen. Deshalb fungieren maxParticipants und duration als Reservierungsanfrage für Verbindungs- und Laufzeitkapazität, anstatt lediglich die erwartete Nutzung zu dokumentieren.
Beide Werte sollten daher bei create-Aufrufen angegeben werden. Werden sie weggelassen, kommen die Standardwerte aus Integrationen & API → Integrations-API zum Einsatz.
Beispiel für Kapazitätsreservierung
Das folgende Beispiel zeigt, wie eine reservierungsbasierte Kapazitätsplanung das Verhalten im Vergleich zur normalen Annahme eines einzelnen Servers verändert:
| Situation | Auswirkung auf die Kapazität |
|---|---|
| Ihr Konto erlaubt 20 gleichzeitige Verbindungen | Dies ist der gesamte Verbindungspool, der für aktive Reservierungen verfügbar ist. |
Konferenz A wird mit maxParticipants = 15 und duration = 120 minutes erstellt | Konferenz A reserviert 15 der 20 verfügbaren Verbindungen für das gesamte zweistündige Reservierungsfenster. |
| Während dieser zwei Stunden wird eine weitere Konferenz erstellt | Sie kann nicht mehr als die verbleibenden 5 Verbindungen reservieren, solange sich Konferenz A noch innerhalb ihres reservierten Zeitfensters befindet. |
| Die zwei Stunden sind vorbei und Konferenz A läuft noch | Konferenz A kann weiterlaufen, aber ihre reservierte Kapazität ist nicht mehr garantiert oder geschützt. |
Konferenz B wird später mit maxParticipants = 10 erstellt | Das System kann Konferenz A automatisch zugunsten von Konferenz B beenden, weil Konferenz A nicht mehr durch eine aktive Reservierung geschützt ist. |
Verhalten des Parameters "duration"
Auf bbbserver.de ist duration Teil der Kapazitätsplanung. Das Meeting endet nicht genau dann, wenn die konfigurierte Zeit überschritten wird. Stattdessen beendet bbbserver.de ein Meeting in folgenden Fällen automatisch:
- 10 Minuten nach dem geplanten Ende, sofern keine Teilnehmer mehr verbunden sind.
- Bei Testabonnements: zum geplanten Ende.
- Spätestens 24 Stunden nach Beginn.
- Wenn die Kapazität für ein anderes Meeting benötigt wird und das Meeting nicht mehr durch seine Reservierung geschützt ist (siehe Beispiel oben).
Wenn Ihr Arbeitsablauf eine feste Endzeit erfordert, planen Sie einen expliziten end-API-Aufruf ein.
Zusätzlicher Parameter für White-Labeling
deactivateBbbserverDefaultChatTexts akzeptiert true oder false und verwendet standardmäßig false.
Solange der Wert false bleibt, stellt bbbserver.de Ihrem welcome-Text eigene Texte voran: einen Link zu bbbserver.de, Einwahlhinweise und einen Hosting-Hinweis. Moderatoren sehen zusätzlich einen Text mit der maximalen Teilnehmerzahl, dem geplanten Zeitfenster und einem Hinweis darauf, dass das Meeting beendet werden kann, wenn die Kapazität benötigt wird. Setzen Sie den Parameter auf true, wenn Sie diese Standardtexte für White-Labeling deaktivieren möchten.
Die Standardtexte können auch in den Kundeneinstellungen ausgeblendet werden. In diesem Fall entfällt der Moderatorentext immer, und der Begrüßungstext entfällt, wenn Sie einen eigenen welcome-Text übergeben.
Nicht verfügbare Endpunkte
Die folgenden API-Aufrufe existieren in der Standard-API, werden aber von der IntegrationAPI nicht implementiert:
getJoinUrl, sendChatMessage, updateRecordings, getRecordingTextTracks, putRecordingTextTrack, hooks/ping
Unveröffentlichte Aufzeichnungen
Wenn Sie die Veröffentlichung einer Aufzeichnung aufheben, wird sie in der API als unpublished angezeigt und von externen Diensten entsprechend verarbeitet. Die Aufzeichnung selbst kann jedoch weiterhin geöffnet werden, wenn der Wiedergabelink bekannt ist.
Webhooks
Hooks müssen für bestimmte Meeting-IDs registriert werden. Eine Registrierung für alle Meetings ohne Angabe einer Meeting-ID wird nicht unterstützt.
Webhook-Ereignisse werden vor der Weiterleitung gefiltert: Nur ausgewählte Felder werden weitergegeben. Teilnehmerdaten wie der Name, external-user-id, der User-Agent und userdata-Parameter werden im Klartext übermittelt. Alle anderen Felder, etwa IP-Adressen der Teilnehmer, Chatnachrichten und Umfragedaten, werden entfernt.
Ratenbegrenzungen
Für die IntegrationAPI gibt es keine Ratenbegrenzungen.
Zusätzlich zur IntegrationAPI bietet bbbserver.de eine separate System API mit plattformspezifischen Funktionen wie Kontoverwaltung und Nutzungsstatistiken. Die System API ist nicht BBB-kompatibel und wird in diesem Leitfaden nicht behandelt.
Häufig gestellte Fragen
maxParticipants und duration Kapazität, Meetings enden nicht exakt nach der konfigurierten Dauer, deactivateBbbserverDefaultChatTexts steuert die Chattexte der Plattform, einige Endpunkte sind nicht verfügbar und Webhooks sind meetingspezifisch.getMeetingInfo, insertDocument und hooks/list. Mit dem Anfrageprotokoll können Sie die API selbst und Ihre eigene Integration testen sowie das Verhalten der API in der Praxis untersuchen.