Перейти к содержанию

Информация о пользователе

Метод получения детальной информации о пользователе в Лайнере по его идентификатору.

Адрес и метод

GET /v2/user/detail/{userId}/

userId
Идентификатор пользователя в Лайнере. Значение > 0

Пример запроса

curl -X GET "https://YOUR_LINER_API_HOST/v2/user/detail/{userId}" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';
$userId = (int)$userId;

$ch = curl_init($host . '/v2/user/detail/' . $userId);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_TIMEOUT => 15,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($response === false) {
    throw new RuntimeException('cURL error: ' . curl_error($ch));
}

curl_close($ch);

echo "HTTP {$httpCode}\n";
echo $response;

const host = "https://YOUR_LINER_API_HOST";
const token = "YOUR_API_TOKEN";
const userId = Number(userId);

const res = await fetch(`${host}/v2/user/detail/${userId}`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  }
});

const data = await res.json();
console.log("HTTP", res.status, data);

Пример ответа

{
  "success": true,
  "message": "",
  "data": {
    "id": 123,
    "name": "Иван",
    "lastName": "Иванов",
    "email": "ivanov@example.com",
    "isActive": true,
    "accessGroup": "call-center",
    "webRtcIsEnabled": true,
    "interfaceLanguageCode": "ru",
    "languageSkillsCode": ["ru"],
    "autoAnswer": 0,
    "phoneMode": "default",
    "avatar": "https://YOUR_LINER_HOST/public/assets/img/placeholders/liner-user.jpg",
    "telegramNotificationsEnabled": false,
    "telegramChatId": null,
    "telegramNotificationsPriority": null,
    "emailNotificationsEnabled": false,
    "emailNotificationsPriority": null,
    "lastLoginAt": "2024-01-01 00:00:00",
    "lastActivityAt": "2024-01-01 00:00:00",
    "createdAt": "2024-01-01T00:00:00+03:00"
  }
}

Поля ответа

Поле Тип Описание
id int Идентификатор пользователя в Лайнере.
name string | null Имя пользователя.
lastName string | null Фамилия пользователя.
email string Email пользователя.
isActive bool Активен ли пользователь.
accessGroup string Группа доступа пользователя. Возможные значения: client, call-center, call-center-senior, arbitration, moderator, admin. Пустая строка — группа не назначена.
webRtcIsEnabled bool Включена ли телефония у пользователя.
interfaceLanguageCode string Код языка интерфейса пользователя. Возможные значения: ru, gb.
languageSkillsCode array Код языков, которыми владеет пользователь. Возможные значения элементов: ru, gb.
autoAnswer int Настройки автоматического ответа. Возможные значение от -1 до 10, где -1 - Мгновенно, 0 - Выключено, остальные значения - количество секунд до автоматического ответа.
phoneMode string Режим телефонии пользователя. Возможные значения: default, outgoing-only, incoming-only, predictive
avatar string Ссылка на аватар пользователя. Если аватар не задан — ссылка на изображение-заглушку.
telegramNotificationsEnabled bool Включены ли Telegram-уведомления.
telegramChatId string | null Идентификатор Telegram-чата для уведомлений.
telegramNotificationsPriority string | null Приоритет Telegram-уведомлений. Возможные значения: null, urgent
emailNotificationsEnabled bool Включены ли Email-уведомления.
emailNotificationsPriority string | null Приоритет Email-уведомлений. Возможные значения: null, urgent
lastLoginAt string | null Дата и время последнего входа в формате гггг-мм-дд чч:мм:сс. null, если пользователь ещё не входил.
lastActivityAt string | null Дата и время последней активности в формате гггг-мм-дд чч:мм:сс.
createdAt string Дата и время создания пользователя (ISO 8601).

Примечание

Выше описана структура поля data. Общий формат ответа API см. в разделе Схема запросов