Call List

Method for retrieving a list of calls for a specific Lead.

Endpoint and method

GET /v2/call/

Parameters

createdAt[0] string
Start of the call creation period for the selection, in ISO_8601 format

createdAt[1] string
End of the call creation period for the selection, in ISO_8601 format

leadIds array<int> required without orderIds
Lead identifiers in Liner. A list of calls will be returned for these leads only. Value > 0.

orderIds array<int> required without leadIds
Order identifiers in Liner. A list of calls will be returned for these orders only. Value > 0.

userIds array<int> optional
User identifiers in Liner who processed the calls. Value > 0.

statusIds array<int> optional
Call status identifiers in Liner. Value > 0.

offset int optional
Pagination parameter. Specifies the offset from which the selection starts. Default is 0.

limit int optional
Pagination parameter. Number of items returned per request. Maximum value is 100. Default is 50.

Request example

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);

Response example

{
  "success": true,
  "message": "",
  "data": {
    "list": [
      {
        "id": 123,
        "sipEndpointId": 456,
        "finishInitiator": "client",
        "direction": "outgoing",
        "leadId": 789,
        "statusCode": "answered",
        "userId": 101,
        "totalDurationSeconds": 120,
        "waitTimeDurationSeconds": 5,
        "talkTimeDurationSeconds": 115,
        "isPredictive": false,
        "clientPhone": "+79001234567",
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ],
    "next": 50,
    "total": 12345
  }
}

Response fields

Fields in data

Fields in list