Отправка стикера
Метод позволяет отправлять стикеры в приватные или групповые чаты. Идентификаторы стикера (sticker_id и sticker_set_id) можно получить из обновлений: когда пользователь отправляет стикер в чат с ботом, в обновлении придёт объект Sticker с нужными идентификаторами.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/sendSticker/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата | Бот должен быть участником чата |
login |
Нет* | string |
Логин пользователя | — |
sticker_set_id |
Да | string |
ID набора стикеров | Можно получить из поля sticker.set_id в обновлении |
sticker_id |
Да | string |
ID стикера в наборе | Можно получить из поля sticker.id в обновлении |
reply_message_id |
Нет | integer |
ID сообщения, на которое будет ответ | Сообщение должно быть из того же чата |
thread_id |
Нет | integer |
ID сообщения, под которым будет открыт тред | — |
disable_notification |
Нет | boolean |
Нужно ли отключить уведомление | Значение по умолчанию: false |
payload_id |
Нет | string |
ID запроса | ID должен быть уникальным для каждого запроса. Запросы с одинаковым ID трактуются как дубликаты |
suggest_buttons |
Нет | SuggestButtons | Клавиатура с кнопками под сообщением | Не более 100 кнопок |
(*) Параметры 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 '{"login": "vasya@example.org", "sticker_set_id": "<set_id>", "sticker_id": "<sticker_id>"}' 'https://botapi.messenger.yandex.net/bot/v1/messages/sendSticker/'
Пример успешного ответа
{"ok": true, "message_id": 1647523230504005}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая