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

Удалить подключение

DELETE /v1/voximplant-sip/:configId

Удаляет SIP-подключение офисной или облачной АТС по ID. Восстановить удалённое подключение через API нельзя — создайте новое при необходимости.

Параметры

Параметр Тип Обяз. Описание
configId (path) number да ID подключения. Список: GET /v1/voximplant-sip

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
if (success && data.deleted) {
  console.log('Подключение удалено, ID:', data.configId)
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
if (success && data.deleted) {
  console.log('Подключение удалено, ID:', data.configId)
}

Поля ответа

Поле Тип Описание
success boolean true при успехе
data.configId number ID удалённого подключения
data.deleted boolean true при успешном удалении

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

JSON 
{
  "success": true,
  "data": {
    "configId": 17,
    "deleted": true
  }
}

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

404 — подключение не найдено или уже удалено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "SIP connection not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS configId — не целое положительное число
404 ENTITY_NOT_FOUND Подключения с таким configId нет среди подключений, доступных ключу, — в том числе при повторном удалении
422 BITRIX_ERROR Битрикс24 не подтвердил удаление, сообщение Bitrix24 did not confirm deletion
422 BITRIX_ERROR Битрикс24 отклонил удаление, причина — в error.message
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Платформа не знает такой строки ключа: опечатка, обрезанное значение или удалённый ключ
401 TOKEN_MISSING У ключа нет доступа к порталу: у личного ключа нет вебхука портала, ключу приложения не передан Authorization: Bearer с токеном сессии
403 SCOPE_DENIED У ключа нет скоупа telephony
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе — разбор причин
429 RATE_LIMITED Превышена частота запросов
429 QUEUE_OVERFLOW Очередь запросов к порталу переполнена, запрос отклонён без ожидания. Задержку подсказывает заголовок Retry-After
429 QUEUE_TIMEOUT Запрос не дождался очереди к порталу и не был отправлен в Битрикс24. Задержку подсказывает заголовок Retry-After
502 BITRIX_UNAVAILABLE Битрикс24 недоступен
503 BITRIX_TIMEOUT Битрикс24 не ответил вовремя

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

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

  • Удалить можно только подключение своего приложения. Метод находит подключение, только если оно создано тем же приложением Битрикс24, что и ключ: ключ приложения — подключения своего приложения, личный ключ — подключения, созданные через вебхуки портала. На configId подключения другого приложения метод отвечает 404 ENTITY_NOT_FOUND.

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