Список участников

GET /v1/bots/:botId/chats/:dialogId/users

Возвращает список участников чата. Бот должен быть участником чата.

Параметры

Параметр Тип Обяз. По умолч. Описание
botId (path) number да — ID бота
dialogId (path) string да — ID диалога (chatXXX)
limit (query) number нет 50 Количество записей (1-200)

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Участников:', data.length)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
data array Массив участников
data[].id number ID пользователя
data[].name string Полное имя
data[].firstName string Имя
data[].lastName string Фамилия
data[].workPosition string Должность
data[].color string Цвет аватара
data[].avatar string URL аватара
data[].gender string Пол
data[].active boolean Активен ли аккаунт
data[].bot boolean Является ли ботом
data[].status string Статус пользователя

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Иван Петров",
      "firstName": "Иван",
      "lastName": "Петров",
      "workPosition": "Менеджер",
      "color": "AZURE",
      "avatar": "",
      "gender": "M",
      "active": true,
      "bot": false,
      "status": "online"
    },
    {
      "id": 42,
      "name": "Техподдержка",
      "firstName": "Техподдержка",
      "lastName": "",
      "workPosition": "Помощник",
      "color": "AZURE",
      "avatar": "",
      "gender": "",
      "active": true,
      "bot": true,
      "status": "online"
    }
  ]
}

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

502 — бот не является участником чата:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Access denied"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Битрикс24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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