## 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 |
|----------|-----|:-----:|----------|
| `configId` (path) | number | yes | Connection ID. List: [`GET /v1/voximplant-sip`](/docs/voximplant-sip/list) |

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
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 |
|------|-----|----------|
| `success` | boolean | `true` on success |
| `data.configId` | number | ID of the deleted connection |
| `data.deleted` | boolean | `true` 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 |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `configId` is not a positive integer |
| 404 | `ENTITY_NOT_FOUND` | No connection with this `configId` among the connections available to the key — including on a repeated deletion |
| 422 | `BITRIX_ERROR` | Bitrix24 did not confirm the deletion. Error message: `Bitrix24 did not confirm deletion` |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the deletion; the reason is in `error.message` |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not sent |
| 401 | `INVALID_API_KEY` | The platform does not recognize the key string: a typo, a truncated value, or a deleted key |
| 401 | `TOKEN_MISSING` | The 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 |
| 403 | `SCOPE_DENIED` | The key does not have the `telephony` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only — see [access rights](/docs/access-rights) |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access — [causes explained](/docs/errors/auth#bitrix_access_denied-403) |
| 429 | `RATE_LIMITED` | Request rate exceeded |
| 429 | `QUEUE_OVERFLOW` | The account request queue is full, so the request is rejected without waiting. The `Retry-After` header suggests the delay |
| 429 | `QUEUE_TIMEOUT` | The request did not get through the account queue in time and was not sent to Bitrix24. The `Retry-After` header suggests the delay |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable |
| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time |

Full list of common API errors — [Errors](/docs/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

- [List connections](/docs/voximplant-sip/list)
- [Create connection](/docs/voximplant-sip/create)
- [SIP connections](/docs/voximplant-sip)
- [Default outgoing line](/docs/voximplant-lines/default)