## Получить избранные сообщения

`GET /v1/chats/:dialogId/favorites`

Возвращает постранично строки избранного текущего пользователя в одном чате вместе с сообщениями и их авторами.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|-----------|------|----------|-------------|
| `dialogId` (path) | string | да | `chat` и реальный ID чата из [загрузки чата](/docs/chats/messages/load), в том числе личного. Числовой ID собеседника и `me` отклоняются |
| `limit` (query) | integer | нет | Строк на страницу: 1–50, по умолчанию 50. Выход за границы ограничивается с отражением в `meta.requestedLimit` и `meta.appliedLimit` |
| `lastId` (query) | integer | нет | Исключающий курсор: `id` последней строки предыдущей страницы |
| `search` (query) | string | нет | Поиск по тексту сообщения |

Нужен скоуп `im`. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются.

## Примеры

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

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

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/favorites" \
  -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/chat1945/favorites', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()
console.log(data)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/favorites', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log(data)
```

## Поля ответа

| Поле | Тип | Описание |
|-------|------|-------------|
| `success` | boolean | `true` |
| `data.list` | array | Строки избранного |
| `data.list[].id` | number | ID связи избранного и курсор следующей страницы |
| `data.list[].messageId` | number | ID сообщения |
| `data.list[].chatId` | number | Реальный ID чата |
| `data.list[].authorId` | number | ID владельца избранного |
| `data.list[].dateCreate` | string | Дата добавления в избранное |
| `data.list[].message` | object | Сообщение: `id`, `chatId`, `authorId`, `date`, `text`, `isSystem`, `params` и признаки прочтения |
| `data.messages, data.additionalMessages` | array | Сопутствующие сообщения. Приходят не в каждом ответе |
| `data.users, data.files` | array | Связанные пользователи и файлы |
| `data.usersShort, data.reactions, data.stickers` | array | Краткие сведения о пользователях, реакции и стикеры сообщений из `data.list`. Приходят не в каждом ответе: в пустой выдаче их нет |
| `data.tariffRestrictions.isHistoryLimitExceeded` | boolean | `true`, когда тариф скрывает часть старой истории чата и её сообщения не попадают в выдачу |
| `meta.requestedLimit` | number | Переданный `limit`. Приходит вместе с `appliedLimit`, только когда значение вышло за диапазон от 1 до 50 |
| `meta.appliedLimit` | number | Применённое значение `limit` — только если оно было приведено к границе |

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

Показаны основные поля сообщения и пользователя.

```json
{
  "success": true,
  "data": {
    "list": [
      {
        "id": 15,
        "messageId": 846,
        "chatId": 1945,
        "authorId": 7,
        "dateCreate": "2026-11-17T10:05:00+03:00",
        "message": {
          "id": 846,
          "chatId": 1945,
          "authorId": 12,
          "date": "2026-11-16T09:30:00+03:00",
          "text": "Release notes are ready",
          "isSystem": false,
          "params": {"favorite": ["7"]},
          "unread": false,
          "viewed": true
        }
      },
      {
        "id": 14,
        "messageId": 845,
        "chatId": 1945,
        "authorId": 7,
        "dateCreate": "2026-11-17T10:04:00+03:00",
        "message": {
          "id": 845,
          "chatId": 1945,
          "authorId": 12,
          "date": "2026-11-16T09:28:00+03:00",
          "text": "Project update",
          "isSystem": false,
          "params": {"favorite": ["7"]},
          "unread": false,
          "viewed": true
        }
      }
    ],
    "users": [{"id": 12, "active": true, "name": "Anna Smith", "type": "user"}],
    "usersShort": [],
    "files": [],
    "reactions": [],
    "stickers": [],
    "tariffRestrictions": {"isHistoryLimitExceeded": false}
  }
}
```

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

400 — передан неизвестный параметр:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `ownerId` is not accepted by GET /v1/chats/:dialogId/favorites. Accepted: lastId, limit, search."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Некорректный ID, неизвестный или повторный параметр либо поле тела |
| 422 | `BITRIX_ERROR` | `error.b24Code` равен `ACCESS_ERROR` — у сотрудника нет доступа к чату или чата нет |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | Нет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `im` |
| 403 | `BITRIX_ACCESS_DENIED` | У текущего пользователя нет доступа |
| 404 | `ENTITY_NOT_FOUND` | Запись не найдена |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил операцию с другим кодом, он — в `error.b24Code` |

Общие ошибки API — [Ошибки](/docs/errors).

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

Строки идут по убыванию ID связи избранного. Завершите чтение, когда строк меньше фактического размера страницы. По умолчанию это 50, для допустимого `limit` — переданное значение, при ограничении — `meta.appliedLimit`. Список не следует загружать при каждом открытии меню сообщения.

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

- [Конфигурация чата](/docs/chats/discovery/configuration)
- [Сообщения](/docs/chats/messages)
