Удалить линию

DELETE /v1/telephony-lines/:number

Удаляет внешнюю линию приложения по идентификатору number. Восстановить удалённую линию через API нельзя — создайте новую с тем же number при необходимости.

Параметры

Параметр Тип Обяз. Описание
number (path) string да Идентификатор линии, заданный при создании. Если содержит спецсимволы — URL-кодировать

Примеры

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

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

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

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

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

javascript 
const number = 'sip-line-1'
const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/telephony-lines/${encodeURIComponent(number)}`,
  {
    method: 'DELETE',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)

if (res.status === 204) {
  console.log('Линия удалена')
}

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

javascript 
const number = 'sip-line-1'
const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/telephony-lines/${encodeURIComponent(number)}`,
  {
    method: 'DELETE',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

if (res.status === 204) {
  console.log('Линия удалена')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом — успех проверяется по коду ответа.

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

http 
HTTP/1.1 204 No Content

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

422 — ошибка Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "External line not found"
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в error.message. Возникает в том числе при попытке удалить несуществующую линию
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 — Ошибки.

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

Обновить линию

PATCH /v1/telephony-lines/:number

Обновляет параметры существующей внешней линии приложения. Идентификатор number задаётся при создании и не меняется. Поля передаются плоско в корне JSON — без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
number (path) string да Идентификатор линии, заданный при создании. Если содержит спецсимволы — URL-кодировать

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

Поле Тип Обяз. Описание
name string нет Новое отображаемое название линии
crmAutoCreate boolean нет Автосоздание CRM-сущности при исходящем звонке: true / false

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/telephony-lines/sip-line-1" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Основная линия (обновлено)"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/telephony-lines/sip-line-1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Основная линия (обновлено)"
  }'

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

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

const { success, data } = await res.json()
console.log('Идентификатор линии:', data.id)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id string Идентификатор обновлённой линии (значение number из URL)

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

JSON 
{
  "success": true,
  "data": {
    "id": "sip-line-1"
  }
}

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

422 — линия не найдена или ошибка Битрикс24:

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

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в error.message
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 — Ошибки.

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

Нужно хотя бы одно обновляемое поле. Распознаются только name и crmAutoCreate. Тело без них (пустое или только с нераспознанными полями) отвечает 422 «There are no fields to update».

serverName не обновляется. Поле есть в GET /v1/telephony-lines/fields, но PATCH с одним serverName отвечает 422 «There are no fields to update» — оно не распознаётся как обновляемое. Значение не сохраняется и не возвращается в чтении.

data.id — это number из URL, не целое число. В отличие от ответа POST /v1/telephony-lines, где data.id является внутренним числовым идентификатором записи, ответ обновления возвращает строку — значение number из пути запроса.

Изменить number через обновление нельзя. Идентификатор фиксируется при создании. Чтобы сменить number — удалите линию и создайте новую с нужным значением.

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