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

Информация о Лиде

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

Адрес и метод

GET /v2/lead/detail/{leadId}/

leadId
Идентификатор Лида в Лайнере. Значение > 0

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

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

<?php

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

$ch = curl_init($host . '/v2/lead/detail/' . $leadId);
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 leadId = Number(leadId);

const res = await fetch(`${host}/v2/lead/detail/${leadId}`, {
  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": "Иван Иванов",
    "phone": "+79001234567",
    "sourceComment": "",
    "ip": "192.168.1.1",
    "externalIdBitrix24": "B24-001",
    "externalIdAmo": "AMO-001",
    "externalIdMacro": "MACRO-001",
    "externalIdDomoplaner": "DP-001",
    "statusId": 10,
    "leadType": "straight",
    "createMethod": "api",
    "isSecondary": false,
    "planningCallDateTime": "2024-01-02T10:00:00Z",
    "priority": 0,
    "utcOffset": 3,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "orderId": 202,
    "orderCode": "order-001",
    "vkId": "123456",
    "instagramLogin": "user_instagram",
    "telegramUserName": "user_telegram",
    "telegramPhone": "+79001234567",
    "customValues": {
      "10": "example value"
    }
  }
}

Поля ответа

Поле Тип Описание
id int Идентификатор Лида в Лайнере.
name string Имя клиента.
phone string Телефон клиента (как правило, в формате E.164, например +79001234567).
sourceComment string Комментарий/лог анкеты (может быть простым текстом или JSON-строкой).
ip string IP пользователя (если собирается).
externalIdBitrix24 string Идентификатор Лида в Битрикс24
externalIdAmo string Идентификатор Лида в Амо ЦРМ
externalIdMacro string Идентификатор Лида в Макро ЦРМ
externalIdDomoplaner string Идентификатор Лида в Домопланере
statusId int Текущий код статуса Лида в Лайнере.
leadType string Тип Лида (например, straight / selection).
createMethod string Способ создания Лида (API/форма/вручную — зависит от системы).
isSecondary bool | null Признак вторичного (повторного) Лида.
planningCallDateTime string Дата/время следующего звонка (ISO-строка/Unix/внутренний формат).
priority int Приоритет Лида в очереди дозвона.
utcOffset int Смещение часового пояса клиента относительно UTC (например, 3, -5).
createdAt string Дата и время создания (ISO 8601).
updatedAt string Дата и время обновления (ISO 8601).
orderId int Идентификатор заказа лида.
orderCode string Символьный код заказа лида.
vkId string Идентификатор пользователя в VK.
instagramLogin string Логин пользователя в Instagram.
telegramUserName string Username пользователя в Telegram.
telegramPhone string Телефон пользователя в Telegram (если известен).
customValues object Словарь значений пользовательских полей: ключ — ID пользовательского поля, значение — сохранённое значение этого поля.

Примечание

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