Получение статуса пользователя

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

GET /users.getStatus

Описание

Возвращает статус пользователя. Если не указан userId или username, возвращается статус текущего пользователя.

Параметры

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

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

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.getStatus?userId=<USER_ID_TO_CHECK>' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

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

Ответ

200 — User status — Статус пользователя. Пример вывода:

{
  "success": true,
  "status": "online",
  "statusText": "Working on project",
  "message": "Working on project"
}