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

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

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

Адрес и метод

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": "{{id}}",
    "name": "{{name}}",
    "lastName": "{{lastName}}",
    "secondName": "{{secondName}}",
    "email": "{{email}}",
    "isActive": "{{isActive}}",
    "accessGroup": "{{accessGroup}}",
    "webRtcEnabled": "{{webRtcEnabled}}",
    "interfaceLanguageCode": "{{interfaceLanguageCode}}",
    "languageSkillCodes": "{{languageSkillCodes}}",
    "autoAnswer": "{{autoAnswer}}",
    "phoneMode": "{{phoneMode}}",
    "avatarUrl": "{{avatarUrl}}",
    "telegramNotificationsEnabled": "{{telegramNotificationsEnabled}}",
    "telegramChatId": "{{telegramChatId}}",
    "telegramNotificationsType": "{{telegramNotificationsType}}",
    "emailNotificationsEnabled": "{{emailNotificationsEnabled}}",
    "emailNotificationsType": "{{emailNotificationsType}}",
    "lastLoginAt": "{{lastLoginAt}}",
    "lastActivityAt": "{{lastActivityAt}}",
    "createdAt": "{{createdAt}}"
  }
}

Поля ответа

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

Примечание

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