api:number:close
Table of Contents
API : Number close
Introduction
This request will close a number (remove it from the customers, and mark it as closed for the next 90 days).
Only numbers that are not in use by a SIP account, MVNO account or hosted PBX can be closed.
Request
| URL | https://api.telecomx.dk/number/NUMBER_ID/close | |
|---|---|---|
| Method | GET | |
| Access level | OWNER RESELLER (if the customer belongs to the reseller) ADMIN (required when the number has no customer) The customer must have the SIP or MVNO feature. |
|
| Param | NUMBER_ID | The number (E.164 format) to close |
Please note that if a number belongs to a number series, the whole series will be closed.
Query example
GET https://api.telecomx.dk/number/+4570305050/close
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | id | Number is invalid (not E.164 format) |
| 404 | not_found | Number not found |
| 409 | id | The number is in use |
| 409 | id | The number is in porting |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/number/close.txt · Last modified: by Mikkel Meerwaldt Jørgensen