Розділ 6 GET POST

sendChatMessage – Надіслати повідомлення в чат

Кінцева точка sendChatMessage дозволяє надсилати повідомлення до публічного чату активної зустрічі через API. Повідомлення відображається як системне або користувацьке повідомлення з ім’ям, видиме всім учасникам. Цю кінцеву точку було введено в BigBlueButton 3.0.

Ця кінцева точка доступна лише в BigBlueButton 3.0 і новіших версіях. В офіційній документації API вона описана мінімально. Подробиці щодо кодів помилок, обмеження частоти запитів і кодування символів офіційно не визначені. undocumented

Ендпоінт

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

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

Параметр Тип Обов’язково За замовчуванням Опис
meetingID String Так — Ідентифікатор цільової зустрічі.
message String Так — Вміст повідомлення (від 1 до 500 символів). Спеціальні символи екрануються автоматично. HTML і Markdown не підтримуються.

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

Параметр Тип Обов’язково За замовчуванням Опис
userName String Ні System Відображуване ім’я відправника (максимум 255 символів). undocumented

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

https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?meetingID=replace-with-meeting-id&message=Welcome+to+the+conference!&userName=System+Admin&checksum=replace-with-checksum

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

Успішний виклик повертає такий XML: 

<response>
  <returncode>SUCCESS</returncode>
  <messageKey></messageKey>
  <message></message>
</response>

Відповіді з помилками

messageKey Опис
checksumError checksum недійсний.
missingParamMeetingID Параметр meetingID не було надано.
meetingNotFound Зустріч не існує або більше не виконується.
validationError message відсутній, порожній або перевищує 500 символів; або userName перевищує 255 символів.
На bbbserver.de ця кінцева точка доступна на всіх тарифах, що працюють на BigBlueButton 3.0 або новішій версії. Ви можете викликати її, використовуючи свої облікові дані API, знайдені в панелі керування сервером.

Випадки використання

  • Надсилайте автоматичні вітальні повідомлення під час початку зустрічі.
  • Доставляйте системні сповіщення із зовнішніх застосунків (наприклад, «Запис розпочнеться через 5 хвилин»).
  • Створюйте інтеграції з ботами, які реагують на події та публікують повідомлення.
  • Створюйте інструменти модерації, які надсилають оголошення всім учасникам.

Обмеження

Пам’ятайте про такі обмеження під час використання цього ендпоінта:

  • Підтримуються лише повідомлення публічного чату. Надсилання приватних повідомлень окремим користувачам неможливе.
  • Без форматування Markdown або HTML. Текст відображається лише як звичайний текст.
  • Повідомлення обмежені 500 символами.
  • Зустріч має бути активною. Повідомлення не можна надсилати до завершених зустрічей.
  • Надсилання повідомлень до breakout rooms не підтримується.

Якщо вам потрібно надсилати довші повідомлення, розгляньте можливість розділити вміст на кілька викликів API. Майте на увазі, що швидкі послідовні виклики можуть підпадати під обмеження частоти, хоча точні ліміти офіційно не задокументовані.

Поширені запитання

Цю кінцеву точку було введено в BigBlueButton 3.0. Вона недоступна в попередніх версіях, таких як 2.6 або 2.7.

Ні. Кінцева точка sendChatMessage підтримує лише публічний чат. Наразі немає API-кінцевої точки для надсилання приватних повідомлень окремим учасникам.

API повертає відповідь validationError. Повідомлення не надсилається. Перед повторною спробою потрібно скоротити текст до 500 символів або менше.

Ні. Вміст повідомлення обробляється як звичайний текст. Будь-які теги HTML або синтаксис Markdown будуть показані буквально, а не відрендерені.

Якщо ви не вкажете userName, повідомлення з’явиться з ім’ям відправника "System". Це підходить для автоматизованих сповіщень і системних попереджень.

Ні. Кінцева точка sendChatMessage націлена лише на головну кімнату зустрічі. Надсилання повідомлень до кімнат для групової роботи не підтримується API.
Посібник з API BigBlueButton