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).

Endpunkt

POST GET

https://api-guide.bbbserver.com/bigbluebutton/api/create?<parameters>&checksum=replace-with-checksum

Erforderliche Parameter

Optionale Parameter

Allgemein

Layout & Erscheinungsbild

Berechtigungen & Sperreinstellungen

Webcam

Funktionen deaktivieren

Verfügbare Werte für disabledFeatures:

Meeting-Lebenszyklus

Präsentation

Aufzeichnung

Whiteboard

Plugins

Gruppenräume

Diese Parameter sind relevant, wenn ein Meeting als Breakout-Raum erstellt wird:

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

Beispiel als XML im POST-Body:

<modules>
  <module name="clientSettingsOverride">
    <![CDATA[
    {
      "public": {
        "app": {
          "appName": "My Conference",
                    "helpLink": "https://api-guide.bbbserver.com/help"
        }
      }
    }
    ]]>
  </module>
</modules>

Bruecken

Meta-Parameter

Beliebige Metadaten koennen als meta_<key>=<value> uebergeben werden. Einige Meta-Parameter haben besondere Bedeutungen:

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>
</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:

bbbserver.de Hinweise

Zusaetzlicher Parameter

Kapazitaetsreservierung

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.
• Wenn nicht angegeben, gelten Standardwerte: 5 Teilnehmer und 60 Minuten (konfigurierbar im Admin-Panel unter „Customer Settings → IntegrationAPI“).
• 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 duration beendet Meetings nicht. Anders als beim Standard-BBB müssen Sie einen end-API-Aufruf senden, um ein Meeting nach einer bestimmten Zeit zu beenden.