Игнорирование пользователя

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

GET /chat.ignoreUser

Описание

Добавляет или удаляет пользователя из списка игнорируемых в указанной комнате.

Параметры

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

Название	Обязательный	Тип данных	Описание
rid	да	string	Идентификатор комнаты
userId	да	string	Идентификатор пользователя для игнорирования
ignore	нет	string	true — игнорировать, false — перестать игнорировать

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.ignoreUser?rid=<ROOM_ID>&userId=<USER_ID_TO_IGNORE>&ignore=true' \
  -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> — идентификатор комнаты;
• <USER_ID_TO_IGNORE> — идентификатор пользователя для игнорирования.

Ответ

200 — Result of ignore user — Пользователь добавлен/удален из игнорируемых. Пример вывода:

{
  "success": true
}