Список звонков

Метод для получения списка звонков по конкретному Лиду.

Адрес и метод

GET /v2/call/

Параметры

createdAt[0] string
Начало периода создания лида для выборки в формате ISO_8601

createdAt[1] string
Конец периода создания лида для выборки в формате ISO_8601

leadIds array<int> обязательный, если нет orderIds
Идентификаторы Лидов в Лайнере, список звонков которых необходимо получить. Значение > 0.

orderIds array<int> обязательный, если нет leadIds
Идентификаторы Заказов в Лайнере, список звонков которых необходимо получить. Значение > 0.

userIds array<int> необязательный
Идентификаторы пользователей в Лайнере, которые обработали звонки. Значение > 0.

statusIds array<int> необязательный
Идентификаторы статусов звонка в Лайнере. Значение > 0.

offset int необязательный
Параметр используется для управления постраничной навигацией. Указывает на смещение (offset), с которого начинается выборка. По умолчанию — 0.

limit int необязательный
Параметр используется для управления постраничной навигацией. Количество элементов, которое возвращается за один запрос. Максимально доступное значение — 100. По умолчанию — 50.

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/call/?createdAt[0]=2023-01-01T00:00:00Z&createdAt[1]=2023-01-31T23:59:59Z&leadIds[]={{leadId}}&orderIds[]={{orderId}}&userIds[]={{userId}}&statusIds[]={{statusId}}&offset=0&limit=50" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';

$query = http_build_query([
    'createdAt' => [
        '2023-01-01T00:00:00Z',
        '2023-01-31T23:59:59Z',
    ],
    'leadIds' => [(int) $leadId],
    'orderIds' => [(int) $orderId],
    'userIds' => [(int) $userId],
    'statusIds' => [(int) $statusId],
    'offset' => 0,
    'limit' => 50,
]);

$ch = curl_init($host . '/v2/call/?' . $query);
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 params = new URLSearchParams();
params.set("createdAt[0]", "2023-01-01T00:00:00Z");
params.set("createdAt[1]", "2023-01-31T23:59:59Z");
params.append("leadIds[]", String(leadId));
params.append("orderIds[]", String(orderId));
params.append("userIds[]", String(userId));
params.append("statusIds[]", String(statusId));
params.set("offset", "0");
params.set("limit", "50");

const res = await fetch(`${host}/v2/call/?${params.toString()}`, {
  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": {
    "list": [
      {
        "id": "{{id}}",
        "sipEndpointId": "{{sipEndpointId}}",
        "finishInitiator": "{{finishInitiator}}",
        "direction": "{{direction}}",
        "leadId": "{{leadId}}",
        "statusCode": "{{statusCode}}",
        "userId": "{{userId}}",
        "totalDurationSeconds": "{{totalDurationSeconds}}",
        "waitTimeDurationSeconds": "{{waitTimeDurationSeconds}}",
        "talkTimeDurationSeconds": "{{talkTimeDurationSeconds}}",
        "isPredictive": "{{isPredictive}}",
        "clientPhone": "{{clientPhone}}",
        "createdAt": "{{createdAt}}"
      }
    ],
    "next": 50,
    "total": 12345
  }
}

Поля ответа

Поля в data

Поля в list