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

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 — Ошибки.

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