Исключение пользователя из канала

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

POST /channels.kick

Описание

Исключает пользователя из публичного канала. Требует прав на управление участниками канала.

Параметры

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

Название	Обязательный	Тип данных	Описание
roomId	нет*	string	Идентификатор канала
roomName	нет*	string	Название канала
userId	нет**	string	Идентификатор пользователя
username	нет**	string	Имя пользователя

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

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

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.kick' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "roomId": "<ROOM_ID>",
  "userId": "<USER_ID_TO_KICK>"
  }'

Где:

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

Ответ

200 — Result of kicking a user — Пользователь исключен. Пример вывода:

{
  "success": true,
  "channel": {
    "_id": "GENERAL",
    "name": "general",
    "usersCount": 24
  }
}