Информация о Заказе

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

Адрес и метод

GET /v2/order/detail/{orderId}/

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

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

CURLPHP (cURL)JavaScript (fetch)

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

<?php

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

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

const res = await fetch(`${host}/v2/order/detail/${orderId}`, {
  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,
    "code": "order-001",
    "serviceTitle": "Внутреннее название",
    "title": "Название заказа",
    "callSchedule": [["09:00", "18:00"]],
    "callHolidayOverrides": ["01.01.2024"],
    "autoDialingEnabled": true,
    "predictiveModeEnabled": false,
    "aiDefaultLanguage": "ru",
    "amdDetectionEnabled": false,
    "callRecordRule": "client_is_connected",
    "sipEndpointUsageScheme": "random_default",
    "agentUserIds": [123, 456],
    "agentGroupIds": [789],
    "showLeadContactsToAgent": true,
    "callAttemptGroupId": 1,
    "qualifiedLeadsPerDayLimit": 100,
    "callScenarioId": 10,
    "leadTransformEnabled": false,
    "status": "success",
    "speechRecognitionEnabled": false,
    "ignoreLeadTimezone": false,
    "sipEndpointIds": [123],
    "customValues": {
      "10": "example value"
    },
    "agentLeadCreationIsAllowed": false,
    "agentLeadEditMode": "during-call",
    "autoProcessCall": true,
    "transferNumbers": [
      {
        "number": "79001234567",
        "names": []
      }
    ],
    "createdAt": "2024-01-01T00:00:00+03:00",
    "updatedAt": "2024-01-01T00:00:00+03:00"
  }
}

Поля ответа

Поле	Тип	Описание
`id`	`int`	Идентификатор Заказа в Лайнере.
`code`	`string`	Код заказа.
`serviceTitle`	`string`	Внутреннее название заказа.
`title`	`string`	Отображаемое название заказа.
`callSchedule`	`array`	Список из 7 элементов (по дням недели), каждый содержит время начала и конца рабочего дня.
`callHolidayOverrides`	`array`	Список праздничных дней в формате `дд.мм.гггг`.
`autoDialingEnabled`	`bool`	Разрешены ли звонки.
`predictiveModeEnabled`	`bool`	Разрешены ли звонки в предиктивном режиме.
`aiDefaultLanguage`	`string \\| null`	Язык по-умолчанию для ИИ. Возможные значения: `ru`, `gb`, `null`.
`amdDetectionEnabled`	`bool`	Включено ли распознавание автоответчиков.
`callRecordRule`	`string`	Когда начинать запись разговора. Возможные значения: `client_is_connected`, `agent_is_connected`.
`sipEndpointUsageScheme`	`string`	Схема использования номеров. Возможные значения: `random_default`, `random_without_repetition`, `even_loaded`, `even_loaded_daily`.
`agentUserIds`	`array`	Идентификаторы агентов, которые могут работать в этом заказе.
`agentGroupIds`	`array`	Идентификаторы групп агентов, которые могут работать в этом заказе.
`showLeadContactsToAgent`	`bool`	Могут ли агенты видеть контакты лидов.
`callAttemptGroupId`	`int`	Идентификатор группы интервалов попыток дозвона.
`qualifiedLeadsPerDayLimit`	`int \\| null`	Максимальное количество целевых лидов в день. `null` — без ограничения.
`callScenarioId`	`int`	Идентификатор сценария разговора.
`leadTransformEnabled`	`bool`	Разрешено ли агенту изменять тип лида.
`status`	`string`	Статус заказа. Возможные значения: `success`, `secondary`, `info`.
`speechRecognitionEnabled`	`bool`	Включено ли распознавание звонков.
`ignoreLeadTimezone`	`bool`	Игнорировать ли часовой пояс клиента.
`sipEndpointIds`	`array`	Список идентификаторов виртуальных номеров.
`customValues`	`array`	Словарь значений пользовательских полей: ключ — ID пользовательского поля, значение — сохранённое значение этого поля. Если значений нет — приходит пустой массив.
`agentLeadCreationIsAllowed`	`bool`	Разрешено ли агенту создавать лидов.
`agentLeadEditMode`	`string`	Режим редактирования лида агентом. Возможные значения: `during-call`, `always`, `never`.
`autoProcessCall`	`bool`	Автоматическая обработка звонка.
`transferNumbers`	`array`	Номера для перевода звонка. Каждый элемент — объект с полями `number` (`string`) и `names` (`array`).
`createdAt`	`string`	Дата и время создания (ISO 8601).
`updatedAt`	`string`	Дата и время обновления (ISO 8601).

Примечание

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