create – Utwórz spotkanie

Punkt końcowy create tworzy nowe spotkanie na serwerze BigBlueButton. Jeśli spotkanie z tym samym meetingID już istnieje, serwer zwraca dane istniejącego spotkania zamiast tworzyć duplikat (zachowanie idempotentne).

Punkt końcowy

POST GET

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

Wymagane parametry

Parametry opcjonalne

Ogólne

Układ i wygląd

Uprawnienia i ustawienia blokady

Kamera

Wyłączanie funkcji

Dostępne wartości dla disabledFeatures:

Cykl życia spotkania

Prezentacja

Nagrywanie

Tablica

Wtyczki

Pokoje podgrup

Te parametry są istotne podczas tworzenia spotkania jako pokoju podgrupy:

Format dla groups:

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

Nadpisanie ustawień klienta

Przykład jako XML w treści POST:

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

Mosty

Parametry meta

Dowolne metadane można przekazać jako meta_<key>=<value>. Niektóre parametry meta mają specjalne znaczenie:

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Jeśli spotkanie o tym samym ID już istnieje, odpowiedź zawiera ostrzeżenie o duplikacie:

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

Przesyłanie prezentacji przez treść POST

Prezentacje można przesłać jako treść XML wraz z żądaniem 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>

Atrybuty dla każdego elementu <document>:

Uwagi bbbserver.de

Dodatkowy parametr

Rezerwacja pojemności

Podczas tworzenia spotkania bbbserver.de rezerwuje pojemność sprzętową:

• Określona liczba uczestników jest gwarantowana i rezerwowana na serwerze na określony czas.
• Zarezerwowana pojemność jest odejmowana od wykupionego limitu jednoczesnych połączeń.
• Jeśli nie określono inaczej, obowiązują wartości domyślne: 5 uczestników i 60 minut (konfigurowalne w panelu administracyjnym w sekcji „Customer Settings → IntegrationAPI”).
• Po upływie czasu trwania spotkanie nadal działa, ale pojemność nie jest już zarezerwowana. bbbserver.de może automatycznie zakończyć spotkanie, jeśli nowe spotkanie będzie wymagało tej pojemności.
• Parametr duration nie kończy spotkań. W przeciwieństwie do standardowego BBB musisz wysłać wywołanie API end, aby zakończyć spotkanie po określonym czasie.