API : PBX : Number blacklists
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.
| API | Description |
|---|---|
| List | List the customers number blacklists |
| Get | Get a number blacklist with all its numbers |
| Create | Create a number blacklist |
| Update | Rename a number blacklist or change its notes |
| Delete | Delete a number blacklist |
| Add number | Add a phone number to a blacklist |
| Delete number | Remove a phone number from a blacklist |
Access
Reading a blacklist requires access level VIEWER. Creating, changing and deleting blacklists and their numbers requires access level MANAGER or above.