Версия API: 4.x последняя 3.x

Вы просматриваете документацию API для BigBlueButton 3.x. Текущая версия — BigBlueButton 4.x. Планируете обновление? В руководстве по миграции перечислены все изменения, которые необходимо внести в ваши вызовы API.

Глава 6 GET

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. Имейте в виду, что быстрые последовательные вызовы могут подпадать под ограничение частоты запросов, хотя точные пределы официально не задокументированы.

Часто задаваемые вопросы

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

Нет. Конечная точка sendChatMessage поддерживает только общий чат. В настоящее время API не предоставляет конечной точки для отправки личных сообщений отдельным участникам.

API возвращает ответ sizeError. Сообщение не отправляется. Перед повторной попыткой необходимо сократить текст до 500 символов или менее.

Markdown — да, HTML — нет. Сообщение преобразуется из Markdown в очищенный от небезопасного содержимого HTML: форматирование, например полужирный текст или ссылки, отображается, а теги HTML экранируются и показываются буквально. Официальная документация утверждает обратное, но исходный код отображает Markdown.

Если вы не укажете userName, сообщение будет отображаться с именем отправителя «System». Это подходит для автоматических уведомлений и системных оповещений.

Не через основную конференцию. Сессионные залы — это отдельные конференции, и sendChatMessage публикует сообщения только в общем чате той конференции, чей meetingID вы передаёте. Сообщение, отправленное в основную конференцию, не пересылается в её сессионные залы.
Руководство по API BigBlueButton