Отправка системного сообщения
Метод позволяет отправлять системные сообщения в приватные или групповые чаты. Системное сообщение отображается в чате без указания отправителя — оно выглядит как нейтральное информационное уведомление, а не как обычное сообщение от бота.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/sendSystemMessage/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата | Бот должен быть участником чата |
login |
Нет* | string |
Логин пользователя | — |
text |
Да | string |
Текст системного сообщения | Не более 6000 символов |
thread_id |
Нет | integer |
ID сообщения, под которым будет открыт тред | — |
disable_notification |
Нет | boolean |
Нужно ли отключить уведомление | Значение по умолчанию: false |
payload_id |
Нет | string |
ID запроса | ID должен быть уникальным для каждого запроса. Запросы с одинаковым ID трактуются как дубликаты |
(*) Параметры chat_id и login являются необязательными, но необходимо заполнить хотя бы один из двух:
- При заполнении
chat_idсообщение будет отправлено в групповой чат, заданный этим ID. - При заполнении
loginсообщение будет отправлено пользователю в приватный чат.
Ограничения
- Бот может отправлять сообщения только в те чаты, в которых он является участником или админом.
- Бот не может отправлять личные сообщения пользователям, для которых это запрещено настройками приватности.
- Бот не может отправлять личные сообщения пользователям вне своей организации.
Результат
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация об отправленном сообщении.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
message_id |
Да | integer |
ID сообщения в чате |
В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
description |
Да | string |
Описание ошибки |
Пример запроса
curl -X POST -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" -d '{"chat_id": "0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9", "text": "Пользователь добавлен в систему"}' 'https://botapi.messenger.yandex.net/bot/v1/messages/sendSystemMessage/'
Пример успешного ответа
{"ok": true, "message_id": 1647523230504005}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая