Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/anchors-list.md индекс документации — /llms.txt
Получить перечень якорей
GET /v1/chats/anchors
Метод в процессе раскатки — выходит в обновлении
im 26.1600.0. Доступен не на всех порталах Битрикс24. Если метод ещё не доступен, API вернёт422 METHOD_NOT_YET_AVAILABLEсerror.release.
Получает ваши отметки непрочитанных упоминаний и реакций на сообщения во всех чатах. Используйте их для счётчиков и перехода к отмеченным сообщениям.
Параметров и тела запроса нет. Любой параметр запроса отклоняется с 400 INVALID_PARAMS. Нужен скоуп im, ключ только для чтения подходит.
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/chats/anchors" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/chats/anchors" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/anchors', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, error } = await res.json()
console.log(success ? data.anchors : error)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/anchors', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data, error } = await res.json()
console.log(success ? data.anchors : error)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.anchors |
Типarray | ОписаниеВсе ваши якоря. Пустой массив, если отметок нет |
Полеdata.anchors[].chatId |
Типnumber | ОписаниеID чата отмеченного сообщения. Для группового чата передайте chatN, где N — это значение, в получение чата |
Полеdata.anchors[].messageId |
Типnumber | ОписаниеID отмеченного сообщения. Для перехода — сообщения вокруг сообщения |
Полеdata.anchors[].fromUserId |
Типnumber | ОписаниеID автора упоминания или реакции. Сведения — список пользователей |
Полеdata.anchors[].type |
Типstring | ОписаниеРод отметки: mention — упоминание, reaction — реакция |
Полеdata.anchors[].subType |
Типstring или null | ОписаниеКод реакции, например like. У упоминания — null |
Полеdata.anchors[].parentChatId |
Типnumber | ОписаниеID родительского чата или 0, если родителя нет. Для группового родительского чата передайте chatN, где N — ненулевой parentChatId, в получение чата |
Полеdata.anchors[].parentMessageId |
Типnumber | ОписаниеID родительского сообщения или 0, если его нет. Для перехода — сообщения вокруг сообщения |
Полеdata.anchors[].recentSections |
Типstring[] | ОписаниеРазделы списка диалогов, к которым относится чат |
Пример ответа
{
"success": true,
"data": {
"anchors": [
{
"chatId": 1945,
"messageId": 846,
"fromUserId": 7,
"type": "reaction",
"subType": "like",
"parentChatId": 0,
"parentMessageId": 0,
"recentSections": ["chat"]
},
{
"chatId": 2001,
"messageId": 845,
"fromUserId": 9,
"type": "mention",
"subType": null,
"parentChatId": 2000,
"parentMessageId": 840,
"recentSections": ["chat", "copilot"]
}
]
}
}
Пример ответа при ошибке
400 — передан параметр запроса:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "Query parameter `limit` is not accepted by GET /v1/chats/anchors. It takes no query parameters."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеПередан параметр запроса. Проверяется до обращения к Битрикс24 |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ОписаниеМетод ещё не доступен на портале. Минимальная версия модуля — в error.release |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 вернул ошибку. Код портала — в error.b24Code, если он распознан |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеБитрикс24 вернул «не найдено». Код портала — в error.b24Code |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа im |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеAPI-ключ не имеет настроенных токенов Битрикс24 |
Полный список общих ошибок API — Ошибки.
Известные особенности
Весь набор одним вызовом. Страниц, фильтров и ограничения числа записей нет. Порядок — по messageId от большего к меньшему.
Доступ к сообщению проверяется при его чтении. В перечне могут остаться якоря сообщений, которые вам недоступны. Наличие отметки не гарантирует, что переход откроет сообщение.
Чтение без изменений. Вызов не снимает якоря, не отмечает сообщения прочитанными и не вступает в чаты. Снять отметки можно по сообщениям или для всего чата.