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

Прочитать позже

POST /v1/chats/messages/:messageId/mark

Отмечает чат сообщения непрочитанным и направляет метку на это сообщение — команда «Прочитать позже» в интерфейсе Битрикс24. Чат определяется по сообщению, dialogId не нужен. Отмеченное сообщение видно в загрузке чата как data.chat.markedId: интерфейс открывает чат на нём.

Метку вместе с указателем снимает DELETE /v1/chats/:dialogId/unread.

Параметры

Параметр Тип Обяз. По умолч. Описание
messageId (path) number да — ID сообщения, положительное целое — поле id сообщения из ленты или загрузки чата

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

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/1002/mark" \
  -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/messages/1002/mark', {
  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/messages/1002/mark', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success } = await res.json()

Поля ответа

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

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

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

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

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

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не является положительным целым числом, передан параметр запроса или поле тела, либо тело — не 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. Несуществующее сообщение — MESSAGE_NOT_FOUND, чат вне списка последних диалогов — MESSAGE_MARK_FAILED
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Метка ставится на строку чата в списке последних диалогов. Если чат скрыт из списка, Битрикс24 отклоняет вызов с кодом MESSAGE_MARK_FAILED. Строка возвращается в список с новым сообщением в чате.
  • Отмеченный чат повторно не отмечается. Если чат уже отмечен непрочитанным — прежним «прочитать позже» или POST /v1/chats/:dialogId/unread, — Битрикс24 оставляет метку и указатель как есть и отвечает успехом. Указатель на другое сообщение ставится так: сначала снимите метку DELETE /v1/chats/:dialogId/unread, затем вызовите этот эндпоинт.

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