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

Список виртуальных номеров

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

Примечание

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

Адрес и метод

GET /v2/sip-endpoint/

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/sip-endpoints/" \
  -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/sip-endpoints/');
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/sip-endpoints/`, {
  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,
      "title": "Виртуальный номер",
      "orderId": null,
      "connectionType": "pstn",
      "params": {"phone": "+79001234567"},
      "isDefault": false,
      "outgoing": true,
      "incoming": true,
      "channels": 2
    }
  ]
}

Поля ответа

Поле Тип Описание
id int Идентификатор виртуального номера.
title string Название виртуального номера.
orderId int | null Персональный заказ, к которому привязан виртуальный номер. Если не привязан — null.
connectionType string Тип виртуального номера. Доступные значения: pstn, sip-reg, sip-wo-reg.
params object Параметры виртуального номера: номер телефона (для pstn) либо конфигурация SIP (для sip-reg / sip-wo-reg).
isDefault bool Используется ли по умолчанию.
outgoing bool Включены ли исходящие звонки для этого номера.
incoming bool Включены ли входящие звонки для этого номера.
channels int Количество каналов. От 2 до 10.

Примечание

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