Ви переглядаєте документацію API для BigBlueButton 3.x. Поточна версія — BigBlueButton 4.x. Плануєте оновлення? У посібнику з міграції наведено всі зміни, які потрібно внести у ваші виклики API.
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 символів). Форматування Markdown відтворюється; теги HTML екрануються й відображаються як звичайний текст. |
Необов’язкові параметри
| Параметр | Тип | Обов’язково | За замовчуванням | Опис |
|---|---|---|---|---|
userName | String | Ні | System | Відображуване ім’я відправника (максимум 255 символів). |
Приклад запиту
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 | Зустріч не існує або вже завершилася, або параметр meetingID не було передано. |
nullError | Параметр message не було надано. |
sizeError | Довжина параметра виходить за дозволені межі: message — 1–500 символів, meetingID — 2–256 символів, userName — не більше ніж 255 символів. |
validationError | meetingID містить недопустимі символи (наприклад, кому). |
Випадки використання
- Надсилайте автоматичні вітальні повідомлення під час початку зустрічі.
- Доставляйте системні сповіщення із зовнішніх застосунків (наприклад, «Запис розпочнеться через 5 хвилин»).
- Створюйте інтеграції з ботами, які реагують на події та публікують повідомлення.
- Створюйте інструменти модерації, які надсилають оголошення всім учасникам.
Обмеження
Пам’ятайте про такі обмеження під час використання цього ендпоінта:
- Підтримуються лише повідомлення публічного чату. Надсилання приватних повідомлень окремим користувачам неможливе.
- Теги HTML екрануються й відображаються як текст; форматування Markdown (наприклад, жирний текст або посилання) відтворюється.
- Повідомлення обмежені 500 символами.
- Зустріч має бути активною. Повідомлення не можна надсилати до завершених зустрічей.
- Повідомлення публікується лише в зустрічі, зазначеній у
meetingID; воно не пересилається до сесійних кімнат цієї зустрічі. - Якщо
disabledFeaturesміститьchat, повідомлення відкидається, хоча виклик повертаєSUCCESS.
Якщо вам потрібно надсилати довші повідомлення, розгляньте можливість розділити вміст на кілька викликів API. Майте на увазі, що швидкі послідовні виклики можуть підпадати під обмеження частоти, хоча точні ліміти офіційно не задокументовані.
Поширені запитання
sendChatMessage підтримує лише публічний чат. Наразі немає API-кінцевої точки для надсилання приватних повідомлень окремим учасникам.sizeError. Повідомлення не надсилається. Перед повторною спробою потрібно скоротити текст до 500 символів або менше.userName, повідомлення з’явиться з ім’ям відправника "System". Це підходить для автоматизованих сповіщень і системних попереджень.sendChatMessage публікує повідомлення лише в загальному чаті зустрічі, чий meetingID ви передаєте. Повідомлення, надіслане до батьківської зустрічі, не пересилається до її сесійних кімнат.