Установка статуса пользователя

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

POST /users.setStatus

Описание

Устанавливает статус пользователя.

Параметры

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

Название	Обязательный	Тип данных	Описание
status	да	string	Статус пользователя: online, away, busy, offline
statusText	нет	string	Текстовый статус пользователя

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.setStatus' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "status": "<STATUS>",
  "statusText": "<STATUS_TEXT>"
  }'

Где:

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

Ответ

200 — Basic API response with success status — Статус установлен. Пример вывода:

{
  "success": true
}