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

Метод и конечная точка

GET /channels.members

Описание

Возвращает список всех участников публичного канала с возможностью фильтрации и пагинации.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
roomId	нет*	string	Идентификатор канала
roomName	нет*	string	Название канала
status	нет	string	Фильтр по статусу: online, away, offline
filter	нет	string	Фильтр по имени пользователя
ids	нет	string	Список ID пользователей через запятую
offset	нет	number	Смещение для пагинации
count	нет	number	Количество результатов на страницу
excludeIds	нет	string	Список ID для исключения

* Должен быть указан один из параметров: roomId или roomName.

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.members?roomId=<ROOM_ID>&offset=0&count=20' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <ROOM_ID> — идентификатор канала.

Ответ

200 — Successfully get channel members — Список участников. Пример вывода:

{
  "success": true,
  "count": 20,
  "offset": 0,
  "total": 25,
  "members": [
    {
      "_id": "7w9BMr9r78W4RNe8x",
      "username": "john.doe",
      "name": "John Doe",
      "status": "online",
      "active": true
    }
  ]
}