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

Очистить историю чата

POST /v1/chats/:dialogId/history/clear

Очищает историю для вызывающего пользователя при scope: "self" или для всех участников при scope: "all". Сам чат сохраняется. Право выполнить выбранную операцию проверяет Битрикс24 от имени пользователя, чьи токены используются в запросе.

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

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога из последних диалогов: chatN, положительный ID пользователя или me. Числовая часть — целое число без ведущих нулей, не больше 9007199254740991

Параметры строки запроса не принимаются.

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

Поле Тип Обяз. Описание
scope string да self — очистить историю для вызывающего пользователя, all — для всех участников. Значения по умолчанию нет

Тело должно быть объектом JSON с единственным полем scope. Другие поля отклоняются до обращения к Битрикс24.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat42/history/clear \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"self"}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat42/history/clear \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scope":"self"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/history/clear', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ scope: 'self' }),
})
const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/history/clear', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ scope: 'self' }),
})
const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при подтверждении операции
data.result boolean true — операция подтверждена

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

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

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

400 — значение scope отсутствует:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Body field `scope` is required."
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Поле scope отсутствует
400 INVALID_PARAMS Некорректный dialogId, значение scope, тип тела, лишнее поле тела или параметр строки запроса
401 TOKEN_MISSING У API-ключа нет настроенных токенов Битрикс24
403 SCOPE_DENIED У API-ключа нет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Режим доступа ключа запрещает менять данные Битрикс24. См. права доступа
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе к выбранной операции
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул отказ. Исходный код, в том числе HISTORY_CLEANUP_CONFLICT, — в error.b24Code
502 BITRIX_UNAVAILABLE Не получено явное подтверждение операции или Битрикс24 недоступен
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя для me

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

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

При ответе 502 операция могла уже изменить данные. Вайбкод не повторяет запись автоматически после ответа 503 от Битрикс24. Перед повторным запросом проверьте состояние чата и получите новое подтверждение пользователя.

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