Линии

Создание, обновление и удаление внешних линий приложения, а также чтение списка линий, арендованных у Voximplant или подключённых по SIP.

Bitrix24 API: telephony.externalLine.*, voximplant.line.get Скоуп: telephony

Список линий приложения

GET /v1/telephony-lines

Возвращает список внешних линий, добавленных приложением через POST /v1/telephony-lines. Список возвращается целиком — фильтрация, сортировка и offset не поддерживаются, нужную линию отбирайте на стороне клиента.

Параметры

Параметр Тип По умолч. Описание
select (query) string — Выборка полей в camelCase: ?select=number,name
limit (query) number 50 Количество записей (до 5000)

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} линий`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив линий
data[].number string Идентификатор линии, заданный при создании
data[].name string | null Отображаемое название. null, если не задано при создании
data[].crmAutoCreate boolean Автосоздание CRM-сущности при исходящем звонке через эту линию: true — создавать, false — не создавать
meta.total number Общее количество линий приложения
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

HTTP 200, пустая выборка:

JSON 
{"success":true,"data":[],"meta":{"total":0,"hasMore":false}}

HTTP 200, одна линия:

JSON 
{
  "success": true,
  "data": [
    {
      "number": "doc-test-line-001",
      "name": "Тестовая линия (аудит)",
      "crmAutoCreate": true
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Пример ответа при ошибке

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'telephony' scope"
  }
}

Ошибки

HTTP Код Описание
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 TOKEN_MISSING Ключ не имеет настроенных токенов
401 KEY_INACTIVE API-ключ неактивен или отозван
403 SCOPE_DENIED Ключу не хватает скоупа telephony
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

Известные особенности

Только линии этого приложения. Список содержит линии, созданные через POST /v1/telephony-lines в рамках текущего API-ключа. Линии, арендованные у Voximplant или подключённые по SIP, доступны через `GET /v1/voximplant-lines`.

Фильтрация, сортировка и offset не работают. Параметры filter, order, offset принимаются без ошибки, но игнорируются — возвращается весь список линий. Работают только limit (ограничивает количество) и select (выбор полей в camelCase). Отбор по номеру или имени делайте на стороне клиента.

Все поля ответа — в camelCase, включая crmAutoCreate (boolean). Ранее это поле приходило в UPPER_SNAKE_CASE строкой "Y"/"N" — с 07.2026 оно нормализовано в camelCase boolean, как и остальные поля.

serverName не возвращается. Поле объявлено в GET /v1/telephony-lines/fields, но в списке не приходит ни при каких условиях — даже если задавалось при создании (детали).

Смотрите также