create – Opret møde

Endepunktet create provisionerer et nyt møde på BigBlueButton-serveren. Hvis der allerede findes et møde med samme meetingID, returnerer serveren de eksisterende mødedata i stedet for at oprette en dublet (idempotent adfærd).

Endepunkt

POST GET

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

Obligatoriske parametre

Valgfrie parametre

Generelt

Layout og udseende

Tilladelser og låseindstillinger

Webkamera

Deaktivering af funktioner

Tilgængelige værdier for disabledFeatures:

Mødets livscyklus

Præsentation

Optagelse

Whiteboard

Udvidelser

Grupperum

Disse parametre er relevante ved oprettelse af et møde som et grupperum:

Format for groups:

[
  {"id": "1", "name": "Group A", "roster": ["userId1", "userId2"]},
  {"id": "2", "name": "Group B", "roster": ["userId3"]},
  {"id": "3", "roster": []}
]

Tilsidesættelse af klientindstillinger

Eksempel som XML i POST-bodyen:

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

Broer

Metaparametre

Vilkårlige metadata kan sendes som meta_<key>=<value>. Nogle metaparametre har særlige betydninger:

Eksempel på anmodning

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

Eksempelsvar

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

Hvis et møde med det samme ID allerede findes, indeholder svaret en advarsel om 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>

Upload af præsentationer via POST-body

Præsentationer kan indsendes som en XML-body med anmodningen POST:

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

Attributter pr. <document>-element:

bbbserver.de Bemærkninger

Yderligere parameter

Kapacitetsreservation

Når du opretter et møde, reserverer bbbserver.de hardwarekapacitet:

• Det angivne antal deltagere er garanteret og reserveret på en server i den angivne varighed.
• Den reserverede kapacitet trækkes fra din bookede kvote af samtidige forbindelser.
• Hvis ikke angivet, gælder standardværdier: 5 deltagere og 60 minutter (kan konfigureres i administrationspanelet under "Customer Settings → IntegrationAPI").
• Efter at varigheden er udløbet, fortsætter mødet med at køre, men kapaciteten er ikke længere reserveret. bbbserver.de kan afslutte mødet automatisk, hvis et nyt møde kræver kapaciteten.
• Parameteren duration afslutter ikke møder. I modsætning til standard-BBB skal du sende et end-API-kald for at afslutte et møde efter et bestemt tidsrum.