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

Поставить метку «непрочитано»

POST /v1/chats/:dialogId/unread

Ставит метку «непрочитано» на строку чата в списке последних диалогов — ту, что мессенджер показывает по команде «Отметить непрочитанным». Метка не зависит от счётчика непрочитанных сообщений: она не отмечает сообщения прочитанными и не делает их непрочитанными.

Параметры

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

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

Примеры

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

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

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

Terminal 
curl -X POST "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: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success } = await res.json()

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

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

const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean Всегда true, см. «Известные особенности»

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

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

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

400 — передано поле тела:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `unread` is not accepted by POST /v1/chats/:dialogId/unread. It takes no body fields."
  }
}

Ошибки

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

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

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

  • Вызов не сообщает, поставлена ли метка. Ответ data.result: true приходит при любом исходе: если чата нет в списке последних диалогов текущего пользователя — например, чат скрыт из списка, — метка не ставится, а ответ тот же. Проверить результат можно по полю unread строки списка последних диалогов в режиме v2 или по isMarkedAsUnread в счётчиках.
  • Повторный вызов на отмеченном чате ничего не меняет: указатель «прочитать позже», если он стоял, остаётся на месте.

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