A number blacklist is a named list of phone numbers that a dialplan item will not accept calls from.
A blacklist belongs to a single customer and is never shared between customers. It can be selected on TRUNK and EXTENSION dialplan items through their numberBlacklist property. When such an item is invoked and the callers number is on the selected blacklist, the PBX rejects the call with busy.
Numbers are stored in E.164 format and matched exactly - a blacklisted number blocks that number and nothing else. On an extension the blacklist is only checked for external callers; local extensions are never filtered, and the extensions own blacklist array is checked as well.
This request removes a single phone number from a blacklist.
| URL | https://api.telecomx.dk/pbx/numberblacklist/BLACKLIST_ID/number/NUMBER | |
|---|---|---|
| Method | DELETE | |
| Access level | MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | BLACKLIST_ID | Id of the blacklist (24 hex-char string) |
| NUMBER | The phone number to remove, in E.164 format. URL-encode the leading + as %2B. |
|
| Query | customer | [optional] Customer the blacklist belongs to. Defaults to the users own customer. |
https://api.telecomx.dk/pbx/numberblacklist/1234567890ABCDEF12345678/number/%2B4570123456
{ success: true }
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in requestURI or not a valid id |
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Number blacklist not found, or the number is not on the blacklist |
| 422 | number | Number is not in E.164 format |
| 500 | internal_error | <Unspecified> |