Удаление сообщения
Метод позволяет удалять сообщения из чатов.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/delete/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата | Бот должен быть участником чата |
login |
Нет* | string |
Логин пользователя | — |
message_id |
Да | integer |
ID сообщения, которое надо удалить | Сообщение должно быть из того же чата |
thread_id |
Нет | integer |
Идентификатор треда (timestamp сообщения) | — |
(*) Параметры chat_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", "message_id": 1695644763694005}' 'https://botapi.messenger.yandex.net/bot/v1/messages/delete/'
Пример успешного ответа
{"ok": true, "message_id": 1695644763694005}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая