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

Снять якоря чата

POST /v1/chats/:dialogId/anchors/read

Снимает все ваши якоря в чате. Якорь — отметка, которой мессенджер Битрикс24 помечает для вас непрочитанное упоминание или реакцию на ваше сообщение: по ней клиент показывает счётчик упоминаний и переход к нужному сообщению. Снять якоря только на выбранных сообщениях — POST /v1/chats/anchors/read.

Параметры

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

Тело не нужно. Параметры запроса и поля тела отклоняются с 400 INVALID_PARAMS.

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/anchors/read" \
  -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/chat42/anchors/read', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success } = await res.json()
console.log('Якоря сняты:', success)

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

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

const { success } = await res.json()
console.log('Якоря сняты:', success)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true, в том числе когда снимать было нечего

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

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

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

400 — передан параметр запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `foo` is not accepted by POST /v1/chats/:dialogId/anchors/read. It takes no query parameters."
  }
}

Ошибки

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

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

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

Это изменение, хотя метод называется read. Вызов удаляет отметки, поэтому ключ только для чтения получает 403 WRITE_BLOCKED_READONLY_KEY до обращения к Битрикс24.

Перечня якорей нет. Список ваших якорей API не отдаёт. Вызов только снимает отметки.

Сообщения прочитанными не становятся. Снятие якорей не двигает отметку прочитанного — для этого отметьте диалог прочитанным.

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