Table of Contents
API : PBX : Number blacklist update
Introduction
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 renames a number blacklist or changes its notes. Use Add number and Delete number to change the numbers on it.
Request
| URL | https://api.telecomx.dk/pbx/numberblacklist/BLACKLIST_ID | |
|---|---|---|
| Method | POST | |
| 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) |
| Query | customer | [optional] Customer the blacklist belongs to. Defaults to the users own customer. |
| Body | name | [optional] New name of the blacklist, 1-100 characters. Must be unique within the customer. |
| notes | [optional] New notes, max 1000 characters. Send null to clear. |
|
Body example
{ name: 'Cold callers (reception)', notes: null }
Response
The updated blacklist, in the same format as Get.
Errors
| 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 |
| 409 | name | A blacklist with that name already exists for the customer |
| 422 | name | Name is longer than 100 characters |
| 500 | internal_error | <Unspecified> |