api:sip:account:delete
Table of Contents
API : SIP Account Delete
Introduction
This request will delete the specified SIP account.
When the SIP account is deleted it will immediately stop accepting new calls and current calls will be terminated. If the account has active portings these will be cancelled.
Request
| URL | https://api.telecomx.dk/sip/ACCOUNT_ID | |
|---|---|---|
| Method | DELETE | |
| Access level | MANAGER or OWNER when user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | ACCOUNT_ID | Id of the SIP account (24 hex-char string) |
| Query | releaseNumbers | 'true' if all numbers on the account should be closed. If not set or 'false', numbers are released so that they can be used on another SIP account. |
Query example
DELETE https://api.telecomx.dk/sip/1234567890ABCDEF12345678 DELETE https://api.telecomx.dk/sip/1234567890ABCDEF12345678?releaseNumbers=true
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | SIP account id not found in request URI |
| 403 | access_denied | Insufficient access level |
| 404 | sipAccount | SIP account not found |
| 409 | numbers | One or more numbers are used by hosted PBX |
| 409 | _id | Cannot delete the default voice account on the customers PBX |
| 500 | internal_error | <Unspecified> |
api/sip/account/delete.txt · Last modified: 2024/05/21 11:03 by Per Møller