## Получить перечень якорей

`GET /v1/chats/anchors`

> **Метод в процессе раскатки — выходит в обновлении `im 26.1600.0`.** Доступен не на всех порталах Битрикс24. Если метод ещё не доступен, API вернёт `422 METHOD_NOT_YET_AVAILABLE` с `error.release`.

Получает ваши отметки непрочитанных упоминаний и реакций на сообщения во всех чатах. Используйте их для счётчиков и перехода к отмеченным сообщениям.

Параметров и тела запроса нет. Любой параметр запроса отклоняется с `400 INVALID_PARAMS`. Нужен скоуп `im`, ключ только для чтения подходит.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/anchors" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

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

const { success, data, error } = await res.json()
console.log(success ? data.anchors : error)
```

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

```javascript
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` — это значение, в [получение чата](/docs/chats/discovery/get) |
| `data.anchors[].messageId` | number | ID отмеченного сообщения. Для перехода — [сообщения вокруг сообщения](/docs/chats/messages/context) |
| `data.anchors[].fromUserId` | number | ID автора упоминания или реакции. Сведения — [список пользователей](/docs/entities/users/list) |
| `data.anchors[].type` | string | Род отметки: `mention` — упоминание, `reaction` — реакция |
| `data.anchors[].subType` | string или null | Код реакции, например `like`. У упоминания — `null` |
| `data.anchors[].parentChatId` | number | ID родительского чата или `0`, если родителя нет. Для группового родительского чата передайте `chatN`, где `N` — ненулевой `parentChatId`, в [получение чата](/docs/chats/discovery/get) |
| `data.anchors[].parentMessageId` | number | ID родительского сообщения или `0`, если его нет. Для перехода — [сообщения вокруг сообщения](/docs/chats/messages/context) |
| `data.anchors[].recentSections` | string[] | Разделы списка диалогов, к которым относится чат |

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

```json
{
  "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 — передан параметр запроса:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `limit` is not accepted by GET /v1/chats/anchors. It takes no query parameters."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Передан параметр запроса. Проверяется до обращения к Битрикс24 |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Метод ещё не доступен на портале. Минимальная версия модуля — в `error.release` |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку. Код портала — в `error.b24Code`, если он распознан |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено». Код портала — в `error.b24Code` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

**Весь набор одним вызовом.** Страниц, фильтров и ограничения числа записей нет. Порядок — по `messageId` от большего к меньшему.

**Доступ к сообщению проверяется при его чтении.** В перечне могут остаться якоря сообщений, которые вам недоступны. Наличие отметки не гарантирует, что переход откроет сообщение.

**Чтение без изменений.** Вызов не снимает якоря, не отмечает сообщения прочитанными и не вступает в чаты. Снять отметки можно [по сообщениям](/docs/chats/messages/anchors-messages) или [для всего чата](/docs/chats/messages/anchors).

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

- [Снять якоря сообщений](/docs/chats/messages/anchors-messages)
- [Снять якоря чата](/docs/chats/messages/anchors)
- [Сообщения вокруг сообщения](/docs/chats/messages/context)
- [Счётчики диалогов](/docs/chats/discovery/counters)
