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 символов. |
Сценарии использования
- Отправляйте автоматические приветственные сообщения при начале встречи.
- Доставляйте системные уведомления из внешних приложений (например, «Запись начнётся через 5 минут»).
- Создавайте интеграции с ботами, которые реагируют на события и публикуют сообщения.
- Создавайте инструменты модерации, которые рассылают объявления всем участникам.
Ограничения
Учитывайте следующие ограничения при использовании этого эндпоинта:
- Поддерживаются только сообщения в публичный чат. Отправка личных сообщений отдельным пользователям невозможна.
- Без форматирования Markdown или HTML. Текст отображается только как обычный текст.
- Сообщения ограничены 500 символами.
- Встреча должна быть активной. В завершённые встречи отправлять сообщения нельзя.
- Отправка сообщений в групповые комнаты не поддерживается.
Если вам нужно отправлять более длинные сообщения, рассмотрите возможность разделения содержимого на несколько вызовов API. Имейте в виду, что быстрые последовательные вызовы могут подпадать под ограничение частоты запросов, хотя точные пределы официально не задокументированы.
Часто задаваемые вопросы
sendChatMessage поддерживает только общий чат. В настоящее время API не предоставляет конечной точки для отправки личных сообщений отдельным участникам.validationError. Сообщение не отправляется. Перед повторной попыткой вы должны сократить текст до 500 символов или меньше.userName, сообщение будет отображаться с именем отправителя «System». Это подходит для автоматических уведомлений и системных оповещений.sendChatMessage направляет сообщения только в основную комнату встречи. Отправка сообщений в групповые комнаты через API не поддерживается.