create – Створити зустріч

Кінцева точка create створює нову зустріч на сервері BigBlueButton. Якщо зустріч із таким самим meetingID уже існує, сервер повертає дані наявної зустрічі замість створення дубліката (ідемпотентна поведінка).

Ендпоінт

POST GET

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

Обов’язкові параметри

Необов’язкові параметри

Загальне

Макет і вигляд

Дозволи та налаштування блокування

Вебкамера

Вимкнення функцій

Доступні значення для disabledFeatures:

Життєвий цикл зустрічі

Презентація

Запис

Дошка

Розширення

Сесійні кімнати

Ці параметри мають значення під час створення зустрічі як сесійної кімнати:

Формат для groups:

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

Перевизначення налаштувань клієнта

Приклад як XML у тілі POST:

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

Мости

Мета-параметри

Довільні метадані можна передавати як meta_<key>=<value>. Деякі мета-параметри мають особливе значення:

Приклад запиту

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

Приклад відповіді

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

Якщо зустріч з таким самим ID уже існує, відповідь містить попередження про дублікат:

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

Завантаження презентацій через тіло POST

Презентації можна надсилати як тіло XML разом із запитом 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>

Атрибути для кожного елемента <document>:

bbbserver.de Примітки

Додатковий параметр

Резервування місткості

Під час створення зустрічі bbbserver.de резервує апаратну місткість:

• Указана кількість учасників гарантується й резервується на сервері на вказану тривалість.
• Зарезервована місткість віднімається з вашої заброньованої квоти одночасних підключень.
• Якщо не вказано, застосовуються значення за замовчуванням: 5 учасників і 60 хвилин (налаштовується в панелі адміністратора в розділі "Customer Settings → IntegrationAPI").
• Після завершення тривалості зустріч продовжує працювати, але місткість більше не резервується. bbbserver.de може автоматично завершити зустріч, якщо новій зустрічі знадобиться ця місткість.
• Параметр duration не завершує зустрічі. На відміну від стандартного BBB, ви повинні надіслати API-виклик end, щоб завершити зустріч через певний час.