create – Vergadering maken

Het endpoint create voorziet een nieuwe vergadering op de BigBlueButton-server. Als er al een vergadering met dezelfde meetingID bestaat, retourneert de server de bestaande vergadergegevens in plaats van een duplicaat aan te maken (idempotent gedrag).

Endpoint

POST GET

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

Vereiste parameters

Optionele parameters

Algemeen

Lay-out en uiterlijk

Machtigingen en vergrendelingsinstellingen

Webcam

Functies uitschakelen

Beschikbare waarden voor disabledFeatures:

Vergaderingslevenscyclus

Presentatie

Opname

Whiteboard

Plug-ins

Breakoutruimtes

Deze parameters zijn relevant bij het aanmaken van een vergadering als breakout room:

Formaat voor groups:

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

Overschrijving van clientinstellingen

Voorbeeld als XML in de POST-body:

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

Bruggen

Metaparameters

Willekeurige metadata kunnen worden doorgegeven als meta_<key>=<value>. Sommige metaparameters hebben een speciale betekenis:

Voorbeeldverzoek

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

Voorbeeldrespons

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

Als er al een vergadering met dezelfde ID bestaat, bevat het antwoord een waarschuwing voor een duplicaat:

<response>
  <returncode>SUCCESS</returncode>
    <meetingID>replace-with-meeting-id</meetingID>
  <!-- ... same fields ... -->
  <messageKey>duplicateWarning</messageKey>
  <message>This conference was already in existence...</message>
</response>

Presentaties uploaden via POST-body

Presentaties kunnen worden ingediend als een XML-body met het POST-verzoek:

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

Attributen per <document>-element:

bbbserver.de Notities

Aanvullende parameter

Capaciteitsreservering

Bij het aanmaken van een vergadering reserveert bbbserver.de hardwarecapaciteit:

• Het opgegeven aantal deelnemers wordt gegarandeerd en voor de opgegeven duur op een server gereserveerd.
• De gereserveerde capaciteit wordt afgetrokken van je geboekte quotum voor gelijktijdige verbindingen.
• Als niets is opgegeven, gelden de standaardwaarden: 5 deelnemers en 60 minuten (configureerbaar in het beheerpaneel onder "Customer Settings → IntegrationAPI").
• Nadat de duur is verstreken, blijft de vergadering actief, maar wordt er geen capaciteit meer gereserveerd. bbbserver.de kan de vergadering automatisch beëindigen als een nieuwe vergadering die capaciteit nodig heeft.
• De parameter duration beëindigt geen vergaderingen. In tegenstelling tot standaard BBB moet je een end API-aanroep versturen om een vergadering na een bepaalde tijd te beëindigen.