## Записи участия

`GET /v1/chats/:dialogId/users/relations`

Возвращает записи участия названных пользователей: кто из них в чате и с какой ролью — владелец, менеджер или участник. Подходит, чтобы проверить результат [добавления](/docs/chats/members/add) или [назначения менеджеров](/docs/chats/members/managers-add) без выгрузки всего состава.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `dialogId` (path) | string | да | Идентификатор диалога: `chatXXX` для группового чата, ID пользователя для личного диалога с ним или алиас `me` для личного диалога с собой |
| `userIds` (query) | string | да | От 1 до 50 ID пользователей через запятую, например `5,7`. Каждый — положительное целое без пробелов и ведущих нулей. Повтор ID допустим и входит в лимит 50 |

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

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/chat42/users/relations?userIds=5,7,12" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/chat42/users/relations?userIds=5,7,12" \
  -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/users/relations?userIds=5,7,12', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
const inChat = new Set(data.relations.map((r) => r.userId))
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/users/relations?userIds=5,7,12', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
const inChat = new Set(data.relations.map((r) => r.userId))
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.relations` | array | Записи участия тех из названных, кто состоит в чате. Пользователя не из чата в списке нет |
| `data.relations[].id` | number | ID записи участия |
| `data.relations[].userId` | number | ID пользователя |
| `data.relations[].chatId` | number | ID чата |
| `data.relations[].role` | string | Роль: `owner` — владелец, `manager` — менеджер, `member` — участник |
| `data.relations[].isHidden` | boolean | Скрытое участие |

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

```json
{
  "success": true,
  "data": {
    "relations": [
      {
        "id": 71,
        "userId": 5,
        "chatId": 42,
        "isHidden": false,
        "role": "owner"
      },
      {
        "id": 77,
        "userId": 7,
        "chatId": 42,
        "isHidden": false,
        "role": "member"
      }
    ]
  }
}
```

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

400 — нет `userIds`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`userIds` is required: 1-50 Bitrix24 user ids separated by commas (4,7), each a positive integer without spaces or leading zeros."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `userIds` отсутствует, содержит больше 50 ID или ID не в записи положительного целого; другой параметр или повтор параметра. Проверяется до обращения к Битрикс24 |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения, а чат не подтверждён: передан не `chatN`, и личный диалог не найден в списке последних диалогов того же сотрудника — до 20 страниц и 4000 строк, — либо алиас создаёт диалог. Отказ приходит до обращения к Битрикс24 |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения, и это не личный ключ сотрудника: ключ приложения с сессией пользователя, [менеджмент-ключ](/docs/management-keys) или ключ с неподтверждённым владельцем |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено»; код портала — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку; код портала — в `error.b24Code`. Отсутствующий чат приходит сюда с кодом `CHAT_NOT_FOUND` |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Не удалось определить пользователя при использовании алиаса `me` |

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

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

**Чтение может сделать вас участником.** Если чат разрешает автовступление, Битрикс24 может добавить текущего пользователя в участники. Ключу `READONLY` это чтение разрешено по узкому исключению; оно не отмечает сообщения прочитанными. Права пользователя в Битрикс24 и скоуп `im` сохраняются.

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

- [Список участников](/docs/chats/members/list)
- [Назначить менеджеров](/docs/chats/members/managers-add)
- [Участники чата](/docs/chats/members)