Установка или удаление реакции
Метод позволяет боту поставить реакцию на сообщение или удалить свою ранее поставленную реакцию.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/sendReaction/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата или канала | Бот должен состоять в чате или канале |
login |
Нет* | string |
Логин пользователя для приватного чата | — |
message_id |
Да | integer |
ID сообщения, на которое нужно поставить или с которого нужно удалить реакцию | — |
thread_id |
Нет | integer |
ID треда | Для сообщений в тредах |
reaction |
Нет | Reaction или null |
Реакция для установки | Если передать null или не передавать поле, реакция бота будет удалена |
(*) Параметры chat_id и login являются необязательными, но необходимо заполнить один из двух.
Операция идемпотентна: повторная установка той же реакции или повторное удаление реакции возвращают успешный ответ.
Результат
Результатом успешного запроса является ответ с кодом 200.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
В случае ошибки возвращается соответствующий статус 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","message_id":1702323240544005,"reaction":{"type":"default_reaction","name":"like"}}' \
'https://botapi.messenger.yandex.net/bot/v1/messages/sendReaction/'
Пример успешного ответа
{"ok": true}
Была ли статья полезна?
Предыдущая
Следующая