#Добавить линию

POST /v1/telephony-lines

Регистрирует новую внешнюю линию приложения на портале. После создания линия доступна в `GET /v1/telephony-lines` и может использоваться как fromLine в исходящих звонках. Поля передаются плоско в корне JSON — без обёртки fields.

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

Поле Тип Обяз. Описание
number string да Уникальный идентификатор линии на портале
name string нет Отображаемое название линии
serverName string нет Имя сервера АТС

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Основная линия",
    "serverName": "pbx.example.com"
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Основная линия",
    "serverName": "pbx.example.com"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Основная линия',
    serverName: 'pbx.example.com',
  }),
})

const { success, data } = await res.json()
console.log('Внутренний ID записи:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Основная линия',
    serverName: 'pbx.example.com',
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Внутренний идентификатор записи в Битрикс24. Для последующих операций не используется — обновление и удаление ведутся по number

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

JSON 
{
  "success": true,
  "data": {
    "id": 17
  }
}

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

422 — поле number не передано:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "NUMBER should not be empty"
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в error.message. Причины: не передан number, дублирующий идентификатор
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 — Ошибки.

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

data.id — внутренний идентификатор, не используется для других операций. Обновление и удаление линии выполняются по number из тела запроса, а не по data.id из ответа. Сохраните переданное number — именно оно подставляется в URL PATCH /v1/telephony-lines/:number и DELETE /v1/telephony-lines/:number. Значения с +, пробелами или / допустимы; при подстановке в URL их нужно кодировать: +79161234567 → %2B79161234567.

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