Для AI-агентов: markdown этой страницы — /docs-content/voximplant-lines.md индекс документации — /llms.txt

Линии телефонии

Исходящие линии портала Битрикс24: список доступных линий и выбор линии по умолчанию для всего портала.

Скоуп: telephony | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Линии Voximplant возвращает идентификаторы линий через GET /v1/voximplant-lines.

Получить исходящую линию по умолчанию и назначить её можно для всего портала. Для записи используйте идентификатор из списка доступных линий.

Быстрый старт

Текущая исходящая линия по умолчанию:

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

Ответ содержит ID линии в data.lineId. Поля ответа описаны на странице Получить исходящую линию по умолчанию.

Полный пример

Получить список линий, прочитать текущую линию по умолчанию и назначить другую. Скрипт запускается в Node.js 18+ из файла с расширением .mjs. Смена линии затрагивает весь портал.

javascript
const BASE = 'https://vibecode.bitrix24.tech/v1'
const API_KEY = 'YOUR_API_KEY'

async function call(method, path, body) {
  const headers = { 'X-Api-Key': API_KEY }
  if (body) headers['Content-Type'] = 'application/json'
  const res = await fetch(BASE + path, { method, headers, body: body && JSON.stringify(body) })
  const json = await res.json()
  if (!json.success) throw new Error(`${json.error.code}: ${json.error.message}`)
  return json.data
}

// 1. Список линий портала: [{ id, name }, ...]
const lines = await call('GET', '/voximplant-lines')
console.log('Линии:', lines.map(line => `${line.id} — ${line.name}`))

// 2. Текущая линия по умолчанию
const current = await call('GET', '/voximplant-lines/default')
console.log('Сейчас по умолчанию:', current.lineId)

// 3. Назначить первую линию из списка, которая отличается от текущей
const next = lines.find(line => line.id !== current.lineId)
if (next) {
  const saved = await call('PUT', '/voximplant-lines/default', { lineId: next.id })
  console.log('Назначена:', saved.lineId)
}

Справочник эндпоинтов

Метод Путь Bitrix24 метод Описание
МетодGET Путь/v1/voximplant-lines Bitrix24 методvoximplant.line.get ОписаниеСписок исходящих линий портала
МетодGET Путь/v1/voximplant-lines/default Bitrix24 методvoximplant.line.outgoing.get ОписаниеТекущая исходящая линия по умолчанию
МетодPUT Путь/v1/voximplant-lines/default Bitrix24 методvoximplant.line.outgoing.set ОписаниеНазначить исходящую линию по умолчанию

Коды ошибок

HTTP Код Когда
HTTP400 КодMISSING_REQUIRED_FIELDS КогдаПри смене линии в теле нет lineId, lineId — пустая строка или не строка
HTTP400 КодINVALID_PARAMS КогдаПри смене линии lineId нет в списке GET /v1/voximplant-lines
HTTP400 КодUNSUPPORTED_FILTER КогдаВ запрос списка линий передан параметр filter
HTTP403 КодSCOPE_DENIED КогдаУ ключа нет скоупа telephony
HTTP422 КодBITRIX_ERROR КогдаБитрикс24 отклонил запрос или не подтвердил смену линии, причина — в error.message

Остальные коды методов раздела — в таблицах ## Ошибки на страницах Линии Voximplant, Получить исходящую линию по умолчанию и Назначить исходящую линию по умолчанию. Полный список общих ошибок API — Ошибки.

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