Skip to content
Voxbi Cockpit APIs
API Guides

Templates

A template is a saved set of user-field values you apply to many users at once. Instead of editing each user one by one, you define the values on a template and apply it to a batch of users and groups.

Overview

A template has two parts: the field values and a per-field Override toggle that decides whether each value is actually pushed.

What it does

The Override toggle separates "this value is set on the template" from "this value should overwrite the target's value".

Override state What happens on apply
On The template's value replaces the target user's value.
Off The target user's current value is preserved. The template's value is ignored.

Override is off by default on most fields. Use it liberally in the off state: the point of templates is to push the deltas, not the defaults. A focused template with three fields toggled on is easier to reason about than one with thirty.

Apply overwrites the marked fields on every target user with no per-user opt-out and no rollback, so confirm the targets and the override list first. Templates are batch operations, not standing policies: they do not re-apply automatically when a target group's membership changes.

See also

  • Users - the target of every template apply. Each User-form field is mirrored on the template.
  • Groups - the membership source for group-targeted templates.

Form fields

Fields available in the create and edit forms.

Template

Name

Identifies the template in lists and on the Apply action. Use names that say what the template changes, like "Sales onboarding permissions" or "New hire defaults".

Target users

The individual users this template will be applied to when you run the apply action.

Target groups

The groups whose members this template will be applied to when you run the apply action.

General

Type

The entity type this template applies to (for example, User). Determines which fields are available for override.

Profile information

Enabled

Whether users should be active or disabled. Disabled users cannot log in or receive calls.

Phone language

The phone language for target users. Options: English, German, French.

Group

The group to assign to target users. Overriding this replaces each user's current group.

Tags

Tags for categorization and filtering. Overriding this replaces each user's current tags.

Locations

Physical locations associated with target users.

Languages

Languages spoken by target users. Used for routing calls to language-specific queues.

Call preferences

Voicemail type

The voicemail mode: Disabled, Internal, External, or Enabled (all calls).

Voicemail destination

Where voicemail messages are delivered: Email only or Email and phone.

Show my company default number on twinning calls

Show my company default number when twinning (transferring) an incoming call to my mobile GSM number.

Permissions

Allow telephony

Master switch for telephony. When off, users cannot make or receive calls.

Allow call forwarding

When on, users can set up call forwarding rules.

Allow DND (Do not disturb)

When on, users can activate Do not disturb.

Allow change twinning destination

When on, users can change their own twinning destination numbers from the Voxbi app.

Allow SMS

When on, users can send and receive SMS messages.

VIP

When on, VIP contacts can still reach users even when Do not disturb is active.

Send missed call via email

Send an email notification to this user when they miss a call.

Limit missed call emails to direct calls only

When enabled, missed call email notifications are only sent for calls that rang directly on this extension (not via call flow or twinning).

Allow national calls

When on, users can make national outgoing calls.

Allow EU calls

When on, users can make outgoing calls to EU countries.

Allow world calls

When on, users can make international (world) outgoing calls.

Allow premium calls

When on, users can call premium-rate phone numbers.

Allow anonymous calls

When on, users can hide their caller identity when making outgoing calls.

Allow default outgoing phone numbers

When on, the PBX-level default outgoing phone numbers are available to users.

Show in address book

When on, users appear in the internal address book.

Allow status changer

When on, users can change their presence status from the Voxbi app.

Allow right to disconnect

When on, users can activate the right-to-disconnect feature to prevent calls outside working hours.

Extension roaming

When on, users can log in to any SIP device and use their own extension.

Allow voicemail changes

When on, users can change their own voicemail settings from the Voxbi app.

Concurrent calls

When on, users can handle multiple calls at the same time.

Record your external calls

When on, all external calls are recorded.

Access own call recordings and transcriptions

When on, users can access and listen to their own call recordings.

Record your internal calls

When on, all internal calls are recorded.

Allow in-call recording

When on, users can manually start and stop recording during an active call.

Access group call recordings and transcriptions

Groups whose call recordings the target users can access and listen to.

Allow managing all contacts

When on, users can create, edit, and delete global contacts visible to everyone on the PBX.

Allow managing group contacts

Groups whose shared contacts users can create, edit, and delete.

Allow visibility to group contacts

Groups whose shared contacts users can view and search, without the ability to modify them.

Access to call analytics

When on, users can access the call analytics (Grafana) dashboard.

Roles

Application roles assigned to target users. Roles determine which parts of the admin panel users can access.

Phone buttons

Phone buttons

Phone buttons (BLF keys, speed dials, line keys) to push to target users. These replace the user's own buttons entirely when overridden - they do not merge.

integration_mappings

Maps the template fields to matching fields in a connected integration, so data flows to the right place.

Updated