Para agentes de IA: markdown desta página — /docs-content-en/voximplant-sip/delete.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Delete connection

DELETE /v1/voximplant-sip/:configId

Deletes a SIP connection of an office or cloud PBX by ID. A deleted connection cannot be restored through the API — create a new one if needed.

Parameters

Parameter Type Required Description
ParameterconfigId (path) Typenumber Requiredyes DescriptionConnection ID. List: GET /v1/voximplant-sip

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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('Connection deleted, ID:', data.configId)
}

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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('Connection deleted, ID:', data.configId)
}

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.configId Typenumber DescriptionID of the deleted connection
Fielddata.deleted Typeboolean Descriptiontrue when the connection is deleted

Response example

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

Error response example

404 — the connection is not found or has already been deleted:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionconfigId is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo connection with this configId among the connections available to the key — including on a repeated deletion
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 did not confirm the deletion. Error message: Bitrix24 did not confirm deletion
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the deletion; the reason is in error.message
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not sent
HTTP401 CodeINVALID_API_KEY DescriptionThe platform does not recognize the key string: a typo, a truncated value, or a deleted key
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no access to the portal: a personal key has no portal webhook, or an app key was sent without Authorization: Bearer with a session token
HTTP403 CodeSCOPE_DENIED DescriptionThe key does not have the telephony scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only — see access rights
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access — causes explained
HTTP429 CodeRATE_LIMITED DescriptionRequest rate exceeded
HTTP429 CodeQUEUE_OVERFLOW DescriptionThe account request queue is full, so the request is rejected without waiting. The Retry-After header suggests the delay
HTTP429 CodeQUEUE_TIMEOUT DescriptionThe request did not get through the account queue in time and was not sent to Bitrix24. The Retry-After header suggests the delay
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time

Full list of common API errors — Errors.

Known specifics

  • Only a connection of your own application can be deleted. The method finds a connection only if it was created by the same Bitrix24 application as the key: an app key finds connections of its own application, a personal key finds connections created through Bitrix24 account webhooks. For the configId of another application's connection, the method responds with 404 ENTITY_NOT_FOUND.

See also