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

Список Статусов Звонков

Получение списка статусов звонка в Лайнере. В случае успеха возвращает все статусы.

Примечание

Не реализует пагинацию — возвращается весь список статусов звонка.

Адрес и метод

GET /v2/call-status/

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/call-statuses/" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

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

$ch = curl_init($host . '/v2/call-statuses/');
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 res = await fetch(`${host}/v2/call-statuses/`, {
  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": "{{id}}",
      "code": "{{code}}",
      "title": "{{title}}",
      "description": "{{description}}",
      "sort": "{{sort}}",
      "commentRequired": "{{commentRequired}}",
      "isAvailableForAi": "{{isAvailableForAi}}",
      "agentCallAvailability": "{{agentCallAvailability}}",
      "leadStatusCode": "{{leadStatusCode}}",
      "planningTimeRequired": "{{planningTimeRequired}}",
      "isSystem": "{{isSystem}}"
    }
  ]
}

Поля ответа

Поле Тип Описание
id int Идентификатор статуса.
code string Код статуса.
title string Название статуса.
description string Описание статуса.
sort int Порядок сортировки.
commentRequired bool Обязателен ли комментарий для звонка, который завершен этим статусом.
isAvailableForAi bool Доступен ли статус для ИИ-бота.
agentCallAvailability string Когда статус показывается пользователю после обработки звонка. Доступные значения: after_call_transfer, always, never.
leadStatusCode string | null Код статуса лида, который соответствует данному статусу звонка.
planningTimeRequired bool Обязательно ли запланировать следующий звонок после обработки.
isSystem bool Является ли статус системным.

Примечание

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