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

Снять якоря сообщений

POST /v1/chats/anchors/read

Снимает ваши якоря на указанных сообщениях. Что такое якорь и как снять все якоря чата — POST /v1/chats/:dialogId/anchors/read.

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

Поле Тип Обяз. Описание
messageIds number[] да ID сообщений одного чата: от 1 до 100 штук, каждый — положительное целое. ID — из ленты чата

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

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/anchors/read" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "messageIds": [1001, 1002] }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/anchors/read" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "messageIds": [1001, 1002] }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/anchors/read', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ messageIds: [1001, 1002] }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/anchors/read', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ messageIds: [1001, 1002] }),
})

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

Поля ответа

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

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

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

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

422 — сообщения из разных чатов:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageIds не передан, не массив, пуст, больше 100 элементов или с элементом, который не положительное целое. Также параметр запроса или лишнее поле тела. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code. MESSAGES_IN_DIFFERENT_CHAT_ERROR — сообщения из разных чатов
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

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

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

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