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

Снять метку «непрочитано»

DELETE /v1/chats/:dialogId/unread

Снимает метку «непрочитано» со строки чата в списке последних диалогов и вместе с ней указатель «прочитать позже» — по отдельности их не снять. Сообщения прочитанными не отмечаются — для этого есть POST /v1/chats/:dialogId/read.

Параметры

Параметр Тип Обяз. По умолч. Описание
dialogId (path) string да — Идентификатор диалога: chatXXX для группового чата, ID пользователя для личного диалога или алиас me. Список диалогов — Последние диалоги

Параметров запроса и полей тела нет. Любой параметр запроса или поле тела отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/chat123/unread" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/chat123/unread" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat123/unread', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Непрочитанных сообщений:', data.counter)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat123/unread', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Непрочитанных сообщений:', data.counter)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.chatId number ID чата
data.lastId number ID последнего прочитанного сообщения
data.counter number Число непрочитанных сообщений после вызова — метка на него не влияет
data.viewedMessages array ID сообщений, отмеченных прочитанными. При снятии метки — пустой массив

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

JSON 
{
  "success": true,
  "data": {
    "chatId": 123,
    "lastId": 1002,
    "counter": 0,
    "viewedMessages": []
  }
}

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

422 — чата нет в списке последних диалогов:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса или поле тела, либо тело — не JSON-объект. Проверяется до обращения к Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — вызов меняет состояние чата. Отказ приходит до обращения к Битрикс24
403 BITRIX_ACCESS_DENIED Чата нет или у пользователя нет к нему доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code. Чат вне списка последних диалогов — READ_RECENT_ITEM_NOT_FOUND_ERROR
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя при использовании алиаса me
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Скрытый чат снова попадает в список последних диалогов, когда в нём появляется новое сообщение. До этого вызов на такой чат отклоняется.

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