Для AI-агентов: markdown этой страницы — /docs-content/bots/messages/delete.md индекс документации — /llms.txt

Удалить сообщение

DELETE /v1/bots/:botId/messages/:messageId

Удаляет сообщение. По умолчанию — мягкое скрытие. Для полного удаления из базы данных передайте complete: true.

Параметры

Параметр Тип Обяз. Описание
ПараметрbotId (path) Типnumber Обяз.да ОписаниеID бота. Список: GET /v1/bots
ПараметрmessageId (path) Типnumber Обяз.да ОписаниеID сообщения. Приходит в поле data.id ответа POST /v1/bots/:botId/messages и в поле message.id событий бота

Поля запроса (body)

Параметр Тип Обяз. По умолч. Описание
Параметрcomplete Типboolean Обяз.нет По умолч.false Описаниеtrue — полное удаление из БД, false — мягкое скрытие

Примеры

curl — личный ключ

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/bots/42/messages/1502 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "complete": true }'

curl — OAuth-приложение

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/bots/42/messages/1502 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "complete": true }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1502', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ complete: true }),
})

const { success, data } = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1502', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ complete: true }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеdata.result Типboolean Описаниеtrue при успешном удалении

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

Пример ответа при ошибке

403 — бот принадлежит другому ключу:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_ACCESS_DENIED",
    "message": "This bot belongs to a different API key"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_BOT_ID ОписаниеbotId не является числом
HTTP400 КодINVALID_PARAMS ОписаниеmessageId в пути должен быть положительным целым числом от 1 до 9007199254740991, без знака, ведущих нулей, дроби, экспоненты и пробелов. Ошибка возвращается до вызова Битрикс24
HTTP404 КодBOT_NOT_FOUND ОписаниеБот с таким ID не найден
HTTP403 КодBOT_ACCESS_DENIED ОписаниеБот принадлежит другому API-ключу
HTTP422 КодBITRIX_ERROR ОписаниеОшибка Битрикс24 (текст ошибки в message)
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа imbot
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения — см. права доступа
HTTP410 КодBOT_DISABLED ОписаниеБот отключён и не обрабатывает вызовы API. Как вернуть бота — Бот отключён
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

Системные сообщения: сообщения с authorId = 0 (отправленные с system: true) бот не может удалить, если не является администратором чата.

Пустое тело: для мягкого удаления body можно не передавать.

Смотрите также