#Линии Voximplant

GET /v1/voximplant-lines

Возвращает список линий, арендованных у Voximplant или подключённых по SIP, которые видит портал. Операции создания, обновления и удаления для этих линий недоступны — только чтение. Идентификаторы из этого списка можно передавать как fromLine в исходящих звонках.

#Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log(`Доступно ${data.length} линий`)

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

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

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

#Поля ответа

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

{
  "success": true,
  "data": [
    {"id": "reg133788", "name": "test"},
    {"id": "reg150907", "name": "+79179087621"},
    {"id": "sip7", "name": "Office PBX 1"},
    {"id": "reg151083", "name": "Облачная АТС (9)"},
    {"id": "sip11", "name": "Офисная АТС (11)"},
    {"id": "reg151085", "name": "SIP line 2"}
  ]
}

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

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

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

#Ошибки

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

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

Два типа линий по префиксу id. Идентификаторы reg<N> соответствуют номерам, арендованным у Voximplant; sip<N> — каналам, подключённым по SIP. Оба типа принимаются в качестве fromLine в исходящих звонках.

Источник для исходящих звонков. В параметр fromLine методов callback, auto-call и auto-call-audio можно передавать как id из этого списка, так и number линии приложения из `GET /v1/telephony-lines`. Выбор зависит от того, через какой тип линии выполняется звонок.

Нужны права администратора телефонии. Скоупа telephony у ключа недостаточно: список линий отдаётся только если у владельца ключа (для vibe_app_ — у авторизованного пользователя) есть право управления линиями телефонии в Битрикс24. Без него запрос возвращает 403 BITRIX_ACCESS_DENIED. Право управления линиями телефонии выдаёт администратор портала в настройках телефонии Битрикс24. Та же модель прав распространяется на статистику звонков — без прав администратора телефонии выборка приходит пустой. Это ограничение Битрикс24, а не Вайбкод.

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

• Список линий приложения — GET /v1/telephony-lines
• Callback — POST /v1/calls/callback
• Автодозвон — POST /v1/calls/auto-call
• Автодозвон с аудио — POST /v1/calls/auto-call-audio

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

GET /v1/telephony-lines

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

#Параметры

#Примеры

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

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

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

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

#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-приложение

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()

#Поля ответа

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

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

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

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

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

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

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

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

#Ошибки

Полный список общих ошибок 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, но в списке не приходит ни при каких условиях — даже если задавалось при создании (детали).

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

• Добавить линию — POST /v1/telephony-lines
• Обновить линию — PATCH /v1/telephony-lines/:number
• Удалить линию — DELETE /v1/telephony-lines/:number
• Линии Voximplant — GET /v1/voximplant-lines
• Синтаксис фильтрации
• Исходящие звонки — линии используются как fromLine