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

Создание интервалов попыток звонков

Синхронный метод создания новой группы интервалов попыток звонков в Лайнере. В случае успеха возвращает идентификатор созданной группы.

Адрес и метод

POST /v2/call-attempt/create/

Параметры

title string
Название группы попыток звонков.

intervals array<int>
Список интервалов между звонками в минутах.

isDefault bool необязательный
Является ли группа интервалов группой по умолчанию. По умолчанию — false.

resetAttemptsEnabled bool необязательный
Выполнять ли повтор попыток при просьбе «перезвонить». По умолчанию — false.

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

curl -X POST "https://YOUR_LINER_API_HOST/v2/call-attempt/create/" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -d '{
    "title": "{{title}}",
    "intervals": [{{interval}}, {{interval}}],
    "isDefault": {{isDefault}},
    "resetAttemptsEnabled": {{resetAttemptsEnabled}}
  }'

<?php

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

$payload = [
    'title' => $title,
    'intervals' => [$interval, $interval],
    'isDefault' => isset($isDefault) ? (bool)$isDefault : false,
    'resetAttemptsEnabled' => isset($resetAttemptsEnabled) ? (bool)$resetAttemptsEnabled : false,
];

$ch = curl_init($host . '/v2/call-attempt/create/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    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 payload = {
  title: title,
  intervals: [interval, interval],
  isDefault: isDefault ?? false,
  resetAttemptsEnabled: resetAttemptsEnabled ?? false
};

const res = await fetch(`${host}/v2/call-attempt/create/`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  },
  body: JSON.stringify(payload)
});

const data = await res.json();
console.log("HTTP", res.status, data);

Пример ответа

{
  "success": true,
  "message": "",
  "data": {
    "id": 100200300
  }
}

Структура ответа

Поле Тип Описание
id int Идентификатор созданной группы интервалов попыток звонков.

Примечание

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