Skip to main content

Outbound Whitelist

The Outbound Whitelist controls which external numbers PBX users can dial. Entries define country and prefix rules with associated outbound trunks.

Purpose

Use this module to:

  • Restrict outbound dialing by destination country and prefix
  • Assign outbound trunks to specific destinations
  • Enable or disable rules per destination

Matching Algorithm

The OutboundRoutingService uses a scoring system to select the best matching rule:

  • Country match: +10
  • Full international prefix match: +length of prefix
  • Local prefix match: +length of prefix

The entry with the highest score wins. A prefix that does not match rejects the call entirely.

Permissions

ActionOwnerPBX AdminPBX UserReporter
View whitelistYesYesYesYes
Create whitelist entriesYesYesNoNo
Update whitelist entriesYesYesNoNo
Delete whitelist entriesYesYesNoNo

UI Workflow

Add a Whitelist Entry

  1. Navigate to Outbound Whitelist in the sidebar
  2. Click Add Rule
  3. Enter a name
  4. Select the destination country
  5. Enter the destination prefix
  6. Select the outbound trunk name
  7. Save

Toggle Status

Use the status toggle to enable or disable a rule. Disabled rules are not used for outbound routing.

Key Data Fields

outbound_whitelists Table

ColumnTypeNotes
idbigintPrimary key
organization_idFKTenant scope
namestring
destination_countrystring
destination_prefixstring
outbound_trunk_namestring
statusenumactive, inactive
MethodEndpointPurpose
GET/POST/PUT/DELETE/v1/outbound-whitelist[/{outboundWhitelist}]Standard CRUD
PATCH/v1/outbound-whitelist/{outboundWhitelist}/toggle-statusToggle active status

See the OPBX REST API reference for full schemas.