Table of Contents
API : PBX : Number blacklist create
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 creates a new, empty number blacklist. Add numbers to it with Add number.
Request
| URL | https://api.telecomx.dk/pbx/numberblacklist | |
|---|---|---|
| Method | POST | |
| Access level | MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Body | customer | [optional] Customer to create the blacklist for. Defaults to the users own customer. |
| name | Name of the blacklist, 1-100 characters. Must be unique within the customer. | |
| notes | [optional] Notes about what the blacklist is used for, max 1000 characters. |
|
Body example
{ name: 'Cold callers', notes: 'Sales calls the reception should never see' }
Response
The created blacklist, in the same format as Get.
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Customer not found |
| 409 | name | A blacklist with that name already exists for the customer |
| 422 | name | Name is missing or longer than 100 characters |
| 500 | internal_error | <Unspecified> |