Table of Contents

API : PBX : Number blacklist get

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 returns a single number blacklist including all of its numbers, sorted by number.

Request

URL https://api.telecomx.dk/pbx/numberblacklist/BLACKLIST_ID
Method GET
Access level VIEWER, 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.

Query examples

https://api.telecomx.dk/pbx/numberblacklist/1234567890ABCDEF12345678

Response

JSON object
_id Id Unique id of the blacklist.
customer Id Id of the customer the blacklist belongs to.
name String Name of the blacklist, unique within the customer.
notes String Notes about what the blacklist is used for, null if none.
createdAt Date When the blacklist was created.
updatedAt Date When the blacklist was last changed.
Array of blacklisted numbers
numbers[].number String The blacklisted phone number in E.164 format.
numbers[].description String Why the number is blacklisted, null if no reason was given.
numbers[].createdAt Date When the number was added to the blacklist.
numbers[].employee Id Id of the employee who added the number, null when it was added by the system.

Example

{
  _id: '12345678901234567890ABCD',
  customer: '12345678901234567890ADEF',
  name: 'Cold callers',
  notes: 'Sales calls the reception should never see',
  numbers: [
    {
      number: '+4570123456',
      description: 'Calls every monday morning',
      createdAt: '2026-09-10T08:14:02.000Z',
      employee: '12345678901234567890AAAA'
    }
  ],
  createdAt: '2026-09-10T08:12:44.000Z',
  updatedAt: '2026-09-10T11:02:09.000Z'
}

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
500 internal_error <Unspecified>