API : PBX : Number blacklist delete

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 deletes a number blacklist.

A blacklist that is still selected on one or more dialplan items cannot be deleted - the request is rejected with 409 and the error message names the dialplan items that use it. Clear the numberBlacklist property on those items first. This is deliberate: deleting the list under them would leave the items pointing at nothing and silently stop filtering their calls.

{
  success: true
}