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

Настроить автоудаление сообщений

PUT /v1/chats/:dialogId/auto-delete

Включает автоудаление сообщений чата с выбранной задержкой или выключает его. Задержка задаётся в часах из фиксированного набора.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога: chatXXX для группового чата, числовой ID пользователя для личных сообщений, me — личный диалог текущего пользователя. Чат сущности CRM находится через Найти чат CRM-сущности

Query-параметров у эндпоинта нет: любой параметр в строке запроса отклоняется с 400 INVALID_PARAMS.

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

Поле Тип Обяз. Описание
hours number да Задержка в часах, JSON-число: 1 — час, 24 — сутки, 168 — неделя, 720 — 30 дней. 0 выключает автоудаление. Другие значения и строка "24" отклоняются

Другие поля тела отклоняются с 400 INVALID_PARAMS, сообщение называет лишнее поле.

Примеры

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/auto-delete \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hours": 168}'

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/auto-delete \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"hours": 168}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/auto-delete', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ hours: 168 }),
})

const { data } = await res.json()
console.log('Задержка:', data.messagesAutoDeleteConfigs[0].delay)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/auto-delete', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ hours: 168 }),
})

const { data } = await res.json()
console.log('Задержка:', data.messagesAutoDeleteConfigs[0].delay)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.messagesAutoDeleteConfigs array Настройка автоудаления чата, один элемент
data.messagesAutoDeleteConfigs[].chatId number Числовой ID чата
data.messagesAutoDeleteConfigs[].delay number Задержка в часах, которую сохранил портал. 0 — автоудаление выключено

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

JSON 
{
  "success": true,
  "data": {
    "messagesAutoDeleteConfigs": [
      {
        "delay": 168,
        "chatId": 264427
      }
    ]
  }
}

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

400 — задержки нет в наборе допустимых:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `hours` must be one of 0, 1, 24, 168, 720 (a JSON number; 0 switches auto-delete off)."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS hours нет в теле, это не JSON-число или не одно из значений 0, 1, 24, 168, 720, в теле другое поле, тело не JSON-объект, в строке запроса есть параметр. Проверяется до обращения к Битрикс24
403 BITRIX_ACCESS_DENIED Битрикс24 отказал: пользователь не участник чата или у него нет права менять автоудаление
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. Чата нет — CHAT_NOT_FOUND
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение» — настройка автоудаления считается записью
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 ME_ALIAS_RESOLUTION_FAILED dialogId=me — не удалось определить ID текущего пользователя
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Сверяйте задержку в ответе. Поле delay в ответе — значение, которое сохранил портал, а не повтор запроса. Если оно расходится с hours из запроса, автоудаление настроено не так, как вы просили.

Системное сообщение о включении автоудаления. Включение автоудаления пишет в чат системное сообщение с именем пользователя, от которого идёт вызов.

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