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

Исчезающее сообщение

POST /v1/chats/messages/:messageId/disappear

Необратимо: через указанное время сообщение удаляется у всех участников, отменить таймер или поменять срок нельзя. Чат определяется по сообщению, dialogId не нужен.

Параметры

Параметр Тип Обяз. Описание
messageId (path) number да ID сообщения, положительное целое — из ленты чата (GET /v1/chats/:dialogId/messages) или из ответа отправки

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

Поле Тип Обяз. Описание
hours number да Через сколько часов удалить сообщение: 1, 24, 168 (неделя) или 720 (30 дней). Число или строка из цифр

Другие поля тела и параметры строки запроса отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/1002/disappear \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "hours": 24 }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/1002/disappear \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "hours": 24 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/disappear', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ hours: 24 }),
})

const { success } = await res.json()
console.log('Таймер поставлен:', success)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/disappear', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ hours: 24 }),
})

const { success } = await res.json()
console.log('Таймер поставлен:', success)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true — таймер удаления поставлен

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

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

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

422 — срок не из списка портала:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "WRONG_MESSAGES_AUTO_DELETE_DELAY",
    "b24Code": "WRONG_MESSAGES_AUTO_DELETE_DELAY"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, hours нет или это не положительное целое, лишнее поле тела или параметр строки запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 отказал. Код — в error.b24Code: WRONG_MESSAGES_AUTO_DELETE_DELAY — срок не из списка, ALREADY_DISAPPEARING — таймер уже стоит, MESSAGE_NOT_FOUND — сообщения нет
404 ENTITY_NOT_FOUND Битрикс24 вернул код NOT_FOUND. Код портала — в error.b24Code
403 BITRIX_ACCESS_DENIED Нет права удалить сообщение у всех участников
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

Список сроков — у портала. Платформа проверяет только, что hours — положительное целое. Допустимые значения задаёт портал, на любое другое вызов отвечает 422 BITRIX_ERROR с WRONG_MESSAGES_AUTO_DELETE_DELAY.

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