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

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

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

#Поля запроса (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 boolean true при успешном удалении

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

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

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

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

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

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Мягкое vs полное удаление: без complete: true сообщение помечается удалённым, но остаётся в базе. С complete: true удаляется полностью.

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

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

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