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

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

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

Адрес и метод

GET /v2/order/

Параметры

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

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

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/order/?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([
    'offset' => 0,
    'limit' => 50,
]);

$ch = curl_init($host . '/v2/order/?' . $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("offset", "0");
params.set("limit", "50");

const res = await fetch(`${host}/v2/order/?${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": 123,
        "code": "order-001",
        "serviceTitle": "Внутреннее название",
        "title": "Название заказа",
        "callSchedule": [["09:00", "18:00"]],
        "callHolidayOverrides": ["2024-01-01"],
        "autoDialingEnabled": true,
        "predictiveModeEnabled": false,
        "aiModeEnabled": false,
        "standaloneAiModeEnabled": false,
        "aiModePrompt": "",
        "aiModeFirstPhrase": "",
        "aiDefaultLanguage": "ru",
        "amdDetectionEnabled": false,
        "callRecordRule": "client_is_connected",
        "callCenterPhone": "+79001234567",
        "additionalCallCenterPhones": [],
        "sipEndpointUsageScheme": "random_default",
        "agentUserIds": [123, 456],
        "agentGroupIds": [789],
        "showLeadContactsToAgent": true,
        "callAttemptsGroupId": 1,
        "qualifiedLeadsPerDayLimit": 100,
        "callScenarioId": 10,
        "leadTransformEnabled": false,
        "leadsPriority": 0,
        "status": "success",
        "speechRecognitionEnabled": false,
        "ignoreLeadTimezone": false,
        "sipEndpointIds": [123],
        "customValues": {
          "10": "example value"
        },
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "next": 50,
    "total": 12345
  }
}

Поля ответа

Поля в data

Поле Тип Описание
list array Список Заказов.
next int Смещение для следующего запроса.
total int Общее количество Заказов.

Поля в list

Поле Тип Описание
id int Идентификатор Заказа в Лайнере.
code string Код заказа.
serviceTitle string Внутреннее название заказа.
title string Отображаемое название заказа.
callSchedule array Список, каждый элемент которого содержит время начала и конца рабочего дня.
callHolidayOverrides array Список праздничных дней.
autoDialingEnabled bool Разрешены ли звонки.
predictiveModeEnabled bool Разрешены ли звонки в предиктивном режиме.
aiModeEnabled bool Разрешен ли ИИ звонок.
standaloneAiModeEnabled bool ИИ-обработка без онлайн агентов.
aiModePrompt string Базовый промпт для ИИ бота.
aiModeFirstPhrase string Первая фраза для ИИ бота.
aiDefaultLanguage string Язык по-умолчанию для ИИ. Возможнне значения: ru, gb.
amdDetectionEnabled bool Включено ли распознавание автоответчиков.
callRecordRule string Когда начинать запись разговора. Возможнне значения: client_is_connected, agent_is_connected.
callCenterPhone string Основной номер телефона КЦ.
additionalCallCenterPhones array Дополнительные номера телефона КЦ.
sipEndpointUsageScheme string Схема использования номеров. Возможнне значения: random_default, random_without_repetition, even_loaded, even_loaded_daily.
agentUserIds array Идентификаторы агентов, которые могут работать в этом заказе.
agentGroupIds array Идентификаторы групп агентов, которые могут работать в этом заказе.
showLeadContactsToAgent bool Могут ли агенты видеть контакты лидов.
callAttemptsGroupId int Идентификатор группы интервалов попыток дозвона.
qualifiedLeadsPerDayLimit int Максимальное количество целевых лидов в день.
callScenarioId int Идентификатор сценария разговора.
sipEndpointIds array Список идентификаторов виртуальных номеров.
leadTransformEnabled bool Разрешено ли агенту изменять тип лида.
leadsPriority int Приоритет Лидов в заказе.
status string Статус заказа. Возможные значения: success, secondary, info.
speechRecognitionEnabled bool Включено ли распознавание звонков.
ignoreLeadTimezone bool Игнорировать ли часовой пояс клиента.
customValues object Словарь значений пользовательских полей: ключ — ID пользовательского поля, значение — сохранённое значение этого поля.
createdAt string Дата и время создания (ISO 8601).
updatedAt string Дата и время обновления (ISO 8601).

Примечание

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