Skip to main content

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

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

GET /users.getPreferences

Описание​

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

Параметры​

Метод не требует дополнительных параметров.

Запрос​

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

Где:

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

Ответ​

200 — User preferences — Настройки пользователя. Пример вывода:

{
  "success": true,
  "preferences": {
    "language": "ru",
    "enableAutoAway": true,
    "idleTimeLimit": 300,
    "desktopNotificationDuration": 3,
    "audioNotifications": "mentions",
    "desktopNotifications": "mentions"
  }
}