create – Meeting erstellen
Der Endpunkt create stellt ein neues Meeting auf dem BigBlueButton-Server bereit. Wenn bereits ein Meeting mit derselben meetingID existiert, gibt der Server die vorhandenen Meeting-Daten zurück, anstatt ein Duplikat zu erstellen (idempotentes Verhalten).
Geändert in BigBlueButton 4.0: neue Parameter lockSettingsPresenterPolicy und requireUserConsentBeforeUnmuting, UNIFIED_LAYOUT als neues Standardlayout, LiveKit als standardmäßige Medienbrücke sowie die Entfernung von copyright, logoutTimer, webVoice, sharedNotesEditor und lockSettingsDisableNote. Einzelheiten finden Sie im Migrationsleitfaden.
Endpunkt
POST GET
https://api-guide.bbbserver.com/bigbluebutton/api/create?<parameters>&checksum=replace-with-checksum Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
meetingID | String | Eindeutige Meeting-Kennung (2 bis 256 Zeichen, keine Kommata). |
name | String | Anzeigename des Meetings (2 bis 256 Zeichen). Erforderlich seit BBB 2.4. |
Optionale Parameter
Allgemein
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
attendeePW Deprecated | String | (auto) | Passwort für den Teilnehmerzugang. Veraltet seit BBB 3.0 — wird automatisch erzeugt. |
moderatorPW Deprecated | String | (auto) | Passwort für den Moderatorzugang. Veraltet seit BBB 3.0 — wird automatisch erzeugt. |
welcome | String | — | Begrüßungsnachricht, die im Dialog mit den Sitzungsdetails angezeigt wird. Unterstützt die Platzhalter: %%CONFNAME%%, %%DIALNUM%%, %%CONFNUM%%, %%SERVERURL%%. |
moderatorOnlyMessage | String | — | Nachricht, die im Dialog mit den Sitzungsdetails nur Moderatoren angezeigt wird. |
dialNumber | String | — | Einwahlnummer für die telefonische Teilnahme. |
voiceBridge | String | (auto) | Fünf zufällige Ziffern (können mit 0 beginnen, z. B. 07382), werden automatisch erzeugt. Müssen pro Meeting eindeutig sein. |
maxParticipants | Number | 0 (unlimited) | Maximale Anzahl an Teilnehmenden. Auf bbbserver.de wird dieser Wert für die Kapazitätsreservierung verwendet (siehe Hinweise zu bbbserver.de unten). |
duration | Number | 0 (unlimited) | Maximale Dauer in Minuten. In standardmäßigem BBB endet das Meeting automatisch, wenn die Zeit abgelaufen ist. Auf bbbserver.de wird dies nur für die Kapazitätsplanung verwendet (siehe Hinweise zu bbbserver.de unten). |
logoutURL | String | — | URL, zu der der Benutzer nach dem Logout weitergeleitet wird. |
loginURL | String | — | URL, die den Benutzern während des Meetings zugänglich gemacht wird. BBB 3.0+ |
record | Boolean | false | Aufzeichnung von Medien und Ereignissen aktivieren. |
autoStartRecording | Boolean | false | Die Aufzeichnung startet automatisch, wenn die erste Person beitritt. |
allowStartStopRecording | Boolean | true | Benutzern erlauben, die Aufzeichnung manuell zu starten und zu stoppen. |
recordFullDurationMedia | Boolean | false | Medien für die gesamte Dauer des Meetings aufzeichnen. BBB 2.6.9+ |
muteOnStart | Boolean | true | Alle Teilnehmer stummschalten, wenn sie beitreten. |
guestPolicy | Enum | ALWAYS_ACCEPT | Gastrichtlinie: ALWAYS_ACCEPT, ALWAYS_DENY oder ASK_MODERATOR. |
meetingEndedURL | String | — | Server-zu-Server-Callback-URL, die beim Ende des Meetings mit GET aufgerufen wird. BigBlueButton hängt die Abfrageparameter meetingID und recordingmarks an Ihre URL an (seit 4.0.1). Dies ist der empfohlene Ersatz für meta_endCallbackUrl. BBB 2.2+ |
Layout & Erscheinungsbild
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
meetingLayout | Enum | UNIFIED_LAYOUT | Standardlayout. Mögliche Werte: UNIFIED_LAYOUT, CAMERAS_ONLY, PARTICIPANTS_AND_CHAT_ONLY, PRESENTATION_ONLY, MEDIA_ONLY. Die Layouts CUSTOM_LAYOUT, SMART_LAYOUT, PRESENTATION_FOCUS und VIDEO_FOCUS wurden in BBB 4.0 entfernt. |
logo | String | — | URL eines Logo-Bildes, das oberhalb der Teilnehmerliste angezeigt wird. BBB 2.4+ |
bannerText | String | — | Im Client angezeigter Banner-Text. BBB 2.0+ |
bannerColor | String | — | Hintergrundfarbe des Banners als Hex-Wert, z. B. #FF0000. BBB 2.0+ |
darklogo | String | — | URL eines Logo-Bildes für den Dunkelmodus. BBB 3.0+ |
Berechtigungen & Sperreinstellungen
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
webcamsOnlyForModerator | Boolean | false | Webcams nur für Moderatoren sichtbar. |
allowModsToUnmuteUsers | Boolean | false | Moderatoren erlauben, die Stummschaltung anderer Nutzer aufzuheben. BBB 2.2+ |
allowModsToEjectCameras | Boolean | false | Moderatoren erlauben, die Kameras anderer Nutzer zu schließen. BBB 2.4+ |
allowPromoteGuestToModerator | Boolean | false | Erlauben, Gäste zur Moderatorrolle zu befördern. BBB 2.7.9+ |
lockSettingsDisableCam | Boolean | false | Kamerafreigabe für Teilnehmer sperren. BBB 2.2+ |
lockSettingsDisableMic | Boolean | false | Mikrofon für Teilnehmer sperren (nur zuhören). BBB 2.2+ |
lockSettingsDisablePrivateChat | Boolean | false | Privaten Chat für Teilnehmer sperren. BBB 2.2+ |
lockSettingsDisablePublicChat | Boolean | false | Öffentlichen Chat für Teilnehmer sperren. BBB 2.2+ |
lockSettingsDisableNotes | Boolean | false | Geteilte Notizen für Teilnehmer sperren. BBB 2.5+ Der veraltete Singular-Alias lockSettingsDisableNote wurde in BBB 4.0 entfernt. |
lockSettingsHideUserList | Boolean | false | Teilnehmerliste vor Zuschauern verbergen. BBB 2.2+ |
lockSettingsHideViewersCursor | Boolean | false | Cursor anderer Zuschauer auf dem Whiteboard verbergen. BBB 2.5+ |
lockSettingsHideViewersAnnotation | Boolean | false | Whiteboard-Anmerkungen anderer Zuschauer verbergen. BBB 2.7+ |
lockSettingsLockOnJoin | Boolean | true | Sperreinstellungen sofort anwenden, wenn ein Nutzer beitritt. BBB 2.2+ |
lockSettingsLockOnJoinConfigurable | Boolean | false | Die Anwendung der Einstellung lockSettingsLockOnJoin aktivieren. BBB 2.2+ |
lockSettingsPresenterPolicy | Enum | requireApproval | Richtlinie „Präsentationsrolle anfordern“: moderatorOnly (nur Moderatoren weisen die Präsentationsrolle zu), requireApproval (Zuschauer können die Präsentationsrolle anfordern, ein Moderator genehmigt dies) oder freeForAll (Zuschauer übernehmen die Präsentationsrolle ohne Genehmigung). BBB 4.0+ |
requireUserConsentBeforeUnmuting | Boolean | false | Nur in Verbindung mit allowModsToUnmuteUsers=true relevant. Bei true wird dem Teilnehmer ein Zustimmungsdialog angezeigt, in dem er zustimmen oder ablehnen kann, bevor ein Moderator seine Stummschaltung aufhebt. BBB 4.0+ |
Webcam
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
userCameraCap | Number | 3 | Maximale Anzahl gleichzeitiger Webcams pro Nutzer. BBB 2.4.5+ |
meetingCameraCap | Number | 0 (unlimited) | Maximale Anzahl gleichzeitiger Webcams im Meeting. BBB 2.5+ |
maxPinnedCameras | Number | 3 | Maximale Anzahl angehefteter Webcams. BBB 2.6+ |
Funktionen deaktivieren
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
disabledFeatures | String | — | Kommagetrennte Liste der zu deaktivierenden Funktionen. BBB 2.5+ |
disabledFeaturesExclude | String | — | Kommagetrennte Liste der für dieses Meeting wieder zu aktivierenden Funktionen (überschreibt serverseitige Standardwerte). BBB 2.6.9+ |
Verfügbare Werte für disabledFeatures:
| Wert | Beschreibung |
|---|---|
breakoutRooms | Gruppenräume |
chat | Öffentlicher und privater Chat |
privateChat | Nur privater Chat |
deleteChatMessage | Chatnachrichten löschen BBB 3.0+ |
editChatMessage | Chatnachrichten bearbeiten BBB 3.0+ |
replyChatMessage | Auf Chatnachrichten antworten BBB 3.0+ |
chatMessageReactions | Reaktionen auf Chatnachrichten BBB 3.0+ |
chatEmojiPicker | Emoji-Auswahl im Chat BBB 3.0.9+ |
pinChatMessage | Anheften von Chatnachrichten (Moderatoren) BBB 4.0+ |
downloadPresentationWithAnnotations | Annotierte Präsentation herunterladen |
downloadPresentationConvertedToPdf | Konvertierte Präsentation herunterladen |
downloadPresentationOriginalFile | Originale Präsentationsdatei herunterladen |
snapshotOfCurrentSlide | Schnappschuss der aktuellen Folie |
externalVideos | Externes Video teilen |
importPresentationWithAnnotationsFromBreakoutRooms | Präsentation aus Gruppenräumen importieren |
importSharedNotesFromBreakoutRooms | Geteilte Notizen aus Gruppenräumen importieren |
learningDashboard | Dashboard für Lernanalysen |
learningDashboardDownloadSessionData | Dashboard-Sitzungsdaten herunterladen |
polls | Umfragen |
screenshare | Bildschirmfreigabe |
sharedNotes | Geteilte Notizen |
virtualBackgrounds | Virtuelle Hintergründe |
customVirtualBackgrounds | Benutzerdefinierte virtuelle Hintergründe hochladen |
liveTranscription | Live-Transkription |
presentation | Präsentation |
cameraAsContent | Kamera als Inhalt |
timer | Timer |
infiniteWhiteboard | Unendliches Whiteboard BBB 3.0+ |
raiseHand | Hand heben BBB 3.0.7+ |
userReactions | Benutzerreaktionen BBB 3.0.8+ |
reactions | Emoji-Statusreaktionen (anders als userReactions) BBB 2.7+ |
quizzes | Quizze BBB 3.0.11+ |
plugins | Plugins BBB 3.0.25+ |
multiFunctionalMode | Multifunktionsmodus (zusätzliche Seitenleiste mit einem zweiten Bereich) BBB 4.0+ |
webcamGrid | Webcam-Raster (Avatar-Kacheln für Teilnehmer ohne Kamera, während die Präsentation minimiert ist) BBB 4.0+ |
Die Werte layouts und captions sind in BBB 4.0 nicht mehr gültig. Die Layoutauswahl wurde aus dem Client entfernt, und manuell eingegebene Untertitel haben seit BBB 3.0 keine Wirkung mehr – verwenden Sie liveTranscription, um die automatische Transkription zu deaktivieren.
Meeting-Lebenszyklus
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
endWhenNoModerator | Boolean | false | Das Meeting automatisch beenden, wenn kein Moderator anwesend ist. BBB 2.3+ |
endWhenNoModeratorDelayInMinutes | Number | 1 | Verzögerung in Minuten vor der automatischen Beendigung, wenn kein Moderator anwesend ist. BBB 2.3+ |
meetingExpireIfNoUserJoinedInMinutes | Number | 5 | Das Meeting beenden, wenn innerhalb von so vielen Minuten niemand beitritt. BBB 2.5+ |
meetingExpireWhenLastUserLeftInMinutes | Number | 1 | Das Meeting X Minuten, nachdem der letzte Benutzer gegangen ist, beenden. 0 = deaktiviert. BBB 2.5+ |
meetingKeepEvents | Boolean | false | Ereignisse beibehalten, auch wenn das Meeting nicht aufgezeichnet wird. BBB 2.3+ Seit BBB 4.0 übernehmen Breakout-Räume immer den tatsächlich geltenden Wert ihres übergeordneten Meetings; der Parameter und der Serverstandardwert defaultKeepEvents gelten nur für Meetings auf oberster Ebene. |
learningDashboardCleanupDelayInMinutes | Number | 2 | Verzögerung vor dem Löschen des Learning-Analytics-Dashboards. BBB 2.4+ |
allowRequestsWithoutSession | Boolean | false | Beitritt ohne Sitzungscookie erlauben. BBB 2.4.3+ |
Präsentation
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
preUploadedPresentation | String | — | URL einer Präsentationsdatei zum Vorab-Upload. BBB 2.7.2+ |
preUploadedPresentationName | String | — | Name für die vorab hochgeladene Präsentation. BBB 2.7.2+ |
preUploadedPresentationOverrideDefault | Boolean | true | Die Standardpräsentation unterdrücken (default.pdf). BBB 2.5+ |
maxNumPages | Number | 200 | Maximale Anzahl von Seiten pro Präsentation. BBB 3.0.2+ |
presentationUploadExternalUrl | String | — | URL einer externen Dateiauswahl-Anwendung. BBB 2.6+ |
presentationUploadExternalDescription | String | — | Beschreibung für die externe Upload-Anwendung. BBB 2.6+ |
presentationConversionCacheEnabled | Boolean | — | Präsentations-Cache aktivieren, wenn S3-Speicher verwendet wird. BBB 3.0.2+ |
Seit BBB 4.0.1 werden pro Aufruf höchstens 10 vorab hochgeladene Dokumente übertragen (Servereinstellung maxPresentationsPerRequest; die Standardpräsentation wird nicht mitgezählt). Weitere Dokumente werden verworfen: Das Meeting wird trotzdem erstellt, und die Antwort enthält messageKey documentsDropped. Alle Dokument-URLs werden zuerst validiert, sodass eine fehlerhafte URL den Aufruf mit invalidPresentationUrl scheitern lässt.
Geteilte Notizen
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
sharedNotesInitialContentJsonUrl | String | — | HTTPS-URL, von der der anfängliche Inhalt der gemeinsamen Notizen abgerufen wird (BlockNote JSON-Dokument). Begrenzt durch maxSharedNotesInitialContentUrlPayloadSize (standardmäßig 1024 KiB) mit einem Zeitlimit von 6 Sekunden; bei Überschreitung bleiben die Notizen ohne Fehlermeldung leer. BBB 3.0.25+ |
sharedNotesInitialContentMarkdown | String | — | Unverarbeiteter Markdown-Text, der als anfänglicher Inhalt der gemeinsamen Notizen verwendet wird. sharedNotesInitialContentMarkdownUrl hat Vorrang vor diesem Wert. BBB 3.0.33+ |
sharedNotesInitialContentMarkdownUrl | String | — | HTTPS-URL, von der Markdown für den anfänglichen Inhalt der gemeinsamen Notizen abgerufen wird. Hat Vorrang vor dem Inline-Parameter und dem Modul POST. BBB 3.0.33+ |
BigBlueButton 4.0 hat Etherpad vollständig entfernt – gemeinsame Notizen verwenden immer BlockNote. Der Parameter sharedNotesEditor wird ignoriert, und die Parameter für den anfänglichen Inhalt funktionieren für jede Konferenz. Als anfänglicher Inhalt übergebener Markdown-Text wandelt mermaid-Codeblöcke in Diagramme um (seit 4.0.2).
Aufzeichnung
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
notifyRecordingIsOn | Boolean | false | Einen modalen Dialog für die Aufzeichnungszustimmung anzeigen. BBB 2.6+ |
notifyRecordingAppend | String | — | Optionaler Klartext, der an den Dialog zur Aufzeichnungsbenachrichtigung angehängt wird. Wird nur mit notifyRecordingIsOn=true angezeigt; HTML wird als Text dargestellt. BBB 3.0.36+ |
Whiteboard
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
multiUserWhiteboardEnabled | Boolean | — | Whiteboard-Zugriff automatisch für alle Benutzer aktivieren. Standardmäßig true in Gruppenräumen. BBB 3.0.20+ |
Plugins
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
pluginManifests | JSON | — | Liste der Plugin-Manifeste für die Sitzung. BBB 3.0+ |
pluginManifestsFetchUrl | String | — | URL einer JSON-Datei, die Plugin-Manifest-URLs enthält. BBB 3.0.8+ |
Gruppenräume
Die Parameter isBreakout, parentMeetingID, sequence und freeJoin beschreiben einen Breakout-Raum und werden nur beim Erstellen des Breakout-Raums selbst verwendet (BigBlueButton erledigt dies intern). Die anderen Parameter in dieser Tabelle werden für die übergeordnete Konferenz festgelegt und gelten für deren Breakout-Räume.
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
isBreakout | Boolean | — | Muss für Gruppenräume true sein. |
parentMeetingID | String | — | Meeting-ID des übergeordneten Meetings (erforderlich für Breakout-Räume). |
sequence | Number | — | Sequenznummer des Breakout-Raums (erforderlich für Breakout-Räume). |
freeJoin | Boolean | — | Teilnehmern erlauben, ihren Breakout-Raum frei zu wählen. |
breakoutRoomsPrivateChatEnabled | Boolean | true | Privaten Chat in Breakout-Räumen aktivieren. |
breakoutRoomsRecord | Boolean | false | Breakout-Räume aufzeichnen. |
breakoutRoomsCaptureSlides | Boolean | false | Folien aus Breakout-Räumen erfassen, wenn sie enden. |
breakoutRoomsCaptureNotes | Boolean | false | Notizen aus Breakout-Räumen erfassen, wenn sie enden. |
breakoutRoomsCaptureSlidesFilename | String | — | Dateiname für erfasste Folien. |
breakoutRoomsCaptureNotesFilename | String | — | Dateiname für erfasste Notizen. |
groups | JSON | — | Vordefinierte Gruppenzuweisungen als JSON-Array. |
Format für groups:
[
{"id": "1", "name": "Group A", "roster": ["userId1", "userId2"]},
{"id": "2", "name": "Group B", "roster": ["userId3"]},
{"id": "3", "roster": []}
] Überschreibung der Client-Einstellungen
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
allowOverrideClientSettingsOnCreateCall | Boolean | false | Servereinstellung in bbb-web.properties (kein create-Parameter), die das Modul clientSettingsOverride im POST-Body aktiviert. BBB 3.0+ |
clientSettingsOverride | JSON | — | Überschreibt die Client-Einstellungen aus settings.yml. Wird nur als XML-Modul im Body einer application/xml-POST-Anfrage akzeptiert – nicht als Query- oder Formularparameter. BBB 3.0+ |
clientSettingsOverrideJsonUrl | String | — | URL einer JSON-Datei mit Werten zum Überschreiben der Client-Einstellungen. Funktioniert mit einfachen GET-Anfragen, erfordert keine serverseitige Einstellung und hat Vorrang vor dem Modul clientSettingsOverride. BBB 3.0.25+ |
Der Parameter clientSettingsOverride ist aus Sicherheitsgründen standardmäßig deaktiviert. Seine Werte haben eine höhere Priorität als die serverseitige Konfiguration, und der POST-Body ist nicht durch die checksum geschützt.
Beispiel als XML im POST-Body:
<modules>
<module name="clientSettingsOverride">
<![CDATA[
{
"public": {
"app": {
"clientTitle": "My Conference",
"helpLink": "https://api-guide.bbbserver.com/help"
}
}
}
]]>
</module>
</modules> Bruecken
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
cameraBridge | String | livekit | Für Webcam-Streams verwendete Medienbrücke: bbb-webrtc-sfu oder livekit. BBB 3.0+ |
screenShareBridge | String | livekit | Für die Bildschirmfreigabe verwendete Medienbrücke: bbb-webrtc-sfu oder livekit. BBB 3.0+ |
audioBridge | String | livekit | Für Audio verwendete Medienbrücke: livekit oder bbb-webrtc-sfu. Der Wert freeswitch wird nicht mehr akzeptiert. BBB 3.0+ |
Diese Parameter überschreiben die serverweiten Einstellungen der Medienbrücken für eine einzelne Konferenz.
Seit BBB 4.0 verwenden alle drei Bridges standardmäßig livekit (zuvor bbb-webrtc-sfu). Personen, die sich telefonisch über die Audiobridge LiveKit einwählen, überspringen den Warteraum für Gäste, selbst mit guestPolicy=ASK_MODERATOR. Wenn Ihre Integration auf den Warteraum für Telefonteilnehmende angewiesen ist, übergeben Sie audioBridge=bbb-webrtc-sfu. Dadurch wird die Audiobridge auf FreeSWITCH umgestellt.
Hinweis für bbbserver.de-Kunden: Wir arbeiten daran, die Zugangsbeschränkung für Telefonteilnehmende von BigBlueButton auch bei der Verwendung von LiveKit beizubehalten.
Meta-Parameter
Beliebige Metadaten koennen als meta_<key>=<value> uebergeben werden. Einige Meta-Parameter haben besondere Bedeutungen:
| Meta-Parameter | Beschreibung |
|---|---|
meta_endCallbackUrl | URL für einen GET-Callback, wenn das Meeting endet. Parameter: meetingID, recordingmarks. Ersetzt durch meetingEndedURL: meta_*-Werte können für Benutzer in der Konferenz sichtbar sein, wodurch in der URL enthaltene Tokens offengelegt werden können. |
meta_bbb-recording-ready-url | URL für einen POST-Callback, wenn die Aufzeichnung bereit ist (JWT-signiert). |
meta_analytics-callback-url | URL für einen POST-Callback mit Analysedaten beim Meeting-Ende (JSON). |
meta_bbb-anonymize-chat | Chat-Absender in Aufzeichnungen anonymisieren (nur Teilnehmer). |
meta_bbb-anonymize-chat-moderators | Chat-Absender in Aufzeichnungen anonymisieren (einschliesslich Moderatoren). |
Zusaetzlich zu den meta_*-Parametern werden auch plugin_*-Parameter unterstuetzt. Diese werden als Plugin-Metadaten verarbeitet und koennen Platzhalter in Plugin-Manifest-URLs ersetzen. BBB 3.0.10+
Beispielanfrage
GET https://api-guide.bbbserver.com/bigbluebutton/api/create?name=Demo&meetingID=replace-with-meeting-id&attendeePW=replace-with-password&moderatorPW=replace-with-password&checksum=replace-with-checksum Beispielantwort
<response>
<returncode>SUCCESS</returncode>
<meetingID>replace-with-meeting-id</meetingID>
<internalMeetingID>replace-with-internal-meeting-id</internalMeetingID>
<parentMeetingID>bbb-none</parentMeetingID>
<attendeePW>replace-with-password</attendeePW>
<moderatorPW>replace-with-password</moderatorPW>
<createTime>1715261728123</createTime>
<voiceBridge>70066</voiceBridge>
<dialNumber>613-555-1234</dialNumber>
<createDate>Thu May 09 13:35:28 UTC 2024</createDate>
<hasUserJoined>false</hasUserJoined>
<duration>0</duration>
<hasBeenForciblyEnded>false</hasBeenForciblyEnded>
<messageKey></messageKey>
<message></message>
</response> Wenn bereits ein Meeting mit derselben ID existiert, enthaelt die Antwort eine Warnung ueber ein Duplikat:
<response>
<returncode>SUCCESS</returncode>
<meetingID>replace-with-meeting-id</meetingID>
<!-- ... same fields ... -->
<messageKey>duplicateWarning</messageKey>
<message>This conference was already in existence...</message>
</response> Präsentationen über den POST-Body hochladen
Präsentationen können als XML-Body mit der Anfrage POST übermittelt werden:
<modules>
<module name="presentation">
<document url="https://api-guide.bbbserver.com/files/slides.pdf" filename="slides.pdf"
downloadable="true" removable="false" current="true"/>
<document url="https://api-guide.bbbserver.com/files/extras.pdf" filename="extras.pdf"/>
<document name="inline.pdf">
JVBERi0xLjQK... (Base64-encoded content)
</document>
</module>
</modules> Attribute pro <document>-Element:
| Attribut | Typ | Standard | Beschreibung |
|---|---|---|---|
url | String | — | URL der externen Datei. |
filename | String | — | Dateiname einschließlich Dateierweiterung. Erforderlich, wenn der URL-Pfad nicht mit einem Dateinamen mit Dateierweiterung endet; andernfalls wird das Dokument übersprungen. |
name | String | — | Name für Base64-eingebettete Dokumente. |
downloadable | Boolean | false | Benutzern erlauben, die Praesentation herunterzuladen. |
removable | Boolean | true | Benutzern erlauben, die Praesentation zu entfernen. |
current | Boolean | — | Diese Praesentation wird zuerst geladen. |
Wenn mehrere Dokumente bereitgestellt werden, wird das erste im Client geladen, waehrend die uebrigen im Hintergrund konvertiert werden.
bbbserver.de Hinweise
Zusaetzlicher Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
deactivateBbbserverDefaultChatTexts | Boolean | false | Wenn auf false gesetzt (Standard), fügt bbbserver.de automatisch Chat-Texte ein (Einwahlnummern, Hosting-Hinweis). Ihre eigenen Texte welcome und moderatorOnlyMessage werden danach angehängt. Setzen Sie es auf true, um die bbbserver.de-Texte zu unterdrücken (White-Labeling). |
Kapazitätsreservierung
Auf bbbserver.de haben die Parameter maxParticipants und duration eine besondere Bedeutung und verhalten sich anders als im Standard-BigBlueButton.
Beim Erstellen eines Meetings reserviert bbbserver.de Hardware-Kapazität:
- Die angegebene Teilnehmerzahl wird fuer die angegebene Dauer garantiert und auf einem Server reserviert.
- Die reservierte Kapazitaet wird von Ihrem gebuchten Kontingent gleichzeitiger Verbindungen abgezogen.
- Falls nicht angegeben, gelten die Standardwerte: 5 Teilnehmer und 60 Minuten (im Administrationsbereich unter Integrations & API → Integration API konfigurierbar).
- Nach Ablauf der Dauer läuft das Meeting weiter, aber die Kapazität ist nicht mehr reserviert. bbbserver.de kann das Meeting automatisch beenden, wenn ein neues Meeting die Kapazität benötigt.
- Der Parameter
durationbeendet Meetings nicht. Anders als beim Standard-BBB müssen Sie einenend-API-Aufruf senden, um ein Meeting nach einer bestimmten Zeit zu beenden.
Seit BBB 3.0 sind die Parameter attendeePW und moderatorPW veraltet. Verwenden Sie stattdessen den Parameter role im Endpunkt join, um Rollen zuzuweisen.
Häufig gestellte Fragen
duplicateWarning-Nachrichtenschlüssel.role im Endpunkt join, um Teilnehmer- oder Moderatorrollen zuzuweisen.modules/module-Element mit Dokumenteinträgen enthält. Jedes Dokument kann auf eine externe URL verweisen oder Base64-kodierte Dateidaten enthalten.meta_endCallbackUrl ist ein Metaparameter, der an den Client und die Aufzeichnungsmetadaten weitergegeben werden kann. meetingEndedURL ist ein serverseitiger Callback, der intern bleibt und Clients nicht offengelegt wird. Daher ist er die empfohlene Option für URLs, die geheime Tokens enthalten.maxParticipants und duration. Die reservierten Plätze werden von Ihrem Kontingent gleichzeitiger Verbindungen abgezogen. Nach Ablauf der Dauer läuft das Meeting weiter, ist aber nicht mehr davor geschützt, beendet zu werden, wenn die Kapazität anderswo benötigt wird.allowOverrideClientSettingsOnCreateCall auf true setzen und ein clientSettingsOverride JSON im POST-Body übergeben. Dies ist aus Sicherheitsgründen standardmäßig deaktiviert, da der POST-Body nicht durch die checksum abgedeckt ist.