insertDocument – Вставить презентацию

Эндпоинт insertDocument позволяет загрузить одну или несколько презентаций в уже запущенную встречу BigBlueButton без прерывания текущего докладчика. Документы обрабатываются в фоновом режиме и становятся доступными как дополнительные презентации, на которые докладчик может переключиться в любое время.

Конечная точка

POST https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum
Content-Type: application/xml

Параметры URL

Тело XML — атрибуты документа

Тело запроса должно содержать структуру XML с элементом <module name="presentation">, который включает один или несколько элементов <document>. Каждый документ может быть загружен либо по URL, либо как встроенное содержимое Base64.

Пример запроса — загрузка по URL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum" \
  --header "Content-Type: application/xml" \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<modules>
  <module name="presentation">
        <document url="https://api-guide.bbbserver.com/files/slides.pdf" filename="slides.pdf"
              downloadable="true" removable="true" current="true"/>
  </module>
</modules>'

Пример запроса — встроенная загрузка Base64

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum" \
  --header "Content-Type: application/xml" \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<modules>
  <module name="presentation">
    <document name="inline-slides.pdf">
      JVBERi0xLjQK... (Base64-encoded content)
    </document>
  </module>
</modules>'

Пример ответа

Успешный вызов возвращает следующий XML:

<response>
  <returncode>SUCCESS</returncode>
</response>

Сравнение с загрузкой презентации create

Вы также можете загружать презентации во время создания встречи, используя endpoint create. Следующая таблица подчёркивает различия между двумя подходами:

Советы

• Здесь также поддерживаются те же форматы файлов, что и при обычной загрузке презентаций (PDF, PPTX, DOCX, изображения и т. д.).
• Вы можете вставить несколько документов в одном запросе, добавив больше элементов document внутри блока module.
• Для загрузок по URL всегда задавайте атрибут filename, если URL не содержит распознаваемого расширения файла. Это помогает BigBlueButton определить правильный тип файла.
• Для больших файлов рекомендуется загрузка по URL вместо встроенной загрузки Base64, чтобы сохранить небольшой размер полезной нагрузки запроса.

Сценарии использования

• Динамически предоставляйте слайды из LMS или системы управления контентом во время живой сессии.
• Добавляйте дополнительные материалы во встречу уже после ее начала.
• Создавайте автоматизированных ботов, которые вставляют повестки, заметки встречи или отчеты в уже идущие встречи.
• Позвольте внешним системам отправлять обновленный контент без необходимости для ведущего покидать встречу.