Skip to content
Docs
Voxbi Cockpit APIs
API Guides

Do not disturb (DND)

A DND rule marks incoming calls for a user as blocked, so the telephony platform can stop them from ringing the phone.

Overview

DND rules live on a user. Each rule sets a type (internal or external) and, for external rules, can be narrowed to a single caller identity. A rule can be paused without deleting it, and you can create more than one to cover different cases. The telephony platform carries out the actual blocking, and any further handling of a blocked call (such as a matching "On DND" forward) is configured separately in the user's forwards.

See also

  • User forwards - configure where calls go when DND is active.
  • Users - the parent entity for DND rules.

Form fields

Fields available in the create and edit forms.

Call preferences

Enabled API status

Whether this DND rule is currently blocking calls. Toggle off to pause without deleting the rule.

Type API type

The call direction this rule applies to.

  • internal Internal Applies to calls from within the PBX.
  • external External Applies to calls arriving from outside the PBX.
Phone number API caller_identity_id

Narrows this rule to one caller identity so only calls arriving on that number are blocked. Only available when Type is External.

Shown when

Type is External

Updated