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

Назначить исходящую линию по умолчанию

PUT /v1/voximplant-lines/default

Назначает исходящую линию телефонии, которую портал Битрикс24 использует по умолчанию, и возвращает значение, сохранённое на портале после записи. Настройка общая для всего портала. Прочитать текущую линию — GET /v1/voximplant-lines/default.

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

Поля запроса (body)

Поле Тип Обяз. Описание
ПолеlineId Типstring Обяз.да ОписаниеID линии из GET /v1/voximplant-lines

Примеры

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

Terminal
curl -X PUT "https://vibecode.bitrix24.tech/v1/voximplant-lines/default" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lineId": "reg151083"}'

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

Terminal
curl -X PUT "https://vibecode.bitrix24.tech/v1/voximplant-lines/default" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lineId": "reg151083"}'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-lines/default', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ lineId: 'reg151083' }),
})
const { data } = await res.json()
console.log('Назначена:', data.lineId)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-lines/default', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ lineId: 'reg151083' }),
})
const { data } = await res.json()
console.log('Назначена:', data.lineId)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеНастройка линии
Полеdata.lineId Типstring | null ОписаниеID исходящей линии по умолчанию, прочитанный с портала после записи

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

JSON
{
  "success": true,
  "data": {
    "lineId": "reg151083"
  }
}

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

400 — lineId нет в списке линий портала:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "lineId must come from GET /v1/voximplant-lines"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеВ теле нет lineId, lineId — пустая строка или не строка
HTTP400 КодINVALID_PARAMS ОписаниеlineId нет в списке GET /v1/voximplant-lines. Настройка не меняется
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеПлатформа не знает такой строки ключа: опечатка, обрезанное значение или удалённый ключ
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет доступа к порталу: у личного ключа нет вебхука портала, ключу приложения не передан Authorization: Bearer с токеном сессии
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа telephony
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения пытается сменить линию
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал в доступе — разбор причин
HTTP403 КодB24_TARIFF_RESTRICTION ОписаниеОперация недоступна на тарифе портала
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 не подтвердил смену линии
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос, причина — в error.message
HTTP429 КодRATE_LIMITED ОписаниеПревышена частота запросов
HTTP429 КодQUEUE_OVERFLOW ОписаниеОчередь запросов к порталу переполнена, запрос отклонён без ожидания. Задержку подсказывает заголовок Retry-After
HTTP429 КодQUEUE_TIMEOUT ОписаниеЗапрос не дождался очереди к порталу и не был отправлен в Битрикс24. Задержку подсказывает заголовок Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя
HTTP503 Кодuser_self_deletion_pending ОписаниеВладелец ключа удаляет свою учётную запись на портале. Заголовок Retry-After равен 604800 — столько длится отсрочка удаления

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

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