Skip to main content

Удаление модератора канала

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

POST /channels.removeModerator

Описание​

Лишает пользователя прав модератора публичного канала. Требует прав на управление модераторами канала.

Параметры​

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

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

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

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

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.removeModerator' \
-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_REMOVE>"
}'

Где:

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

Ответ​

200 — Result of removing a Moderator — Модератор удален. Пример вывода:

{
"success": true
}