Skip to content
Docs
Voxbi Cockpit APIs
API Guides

PBX settings

Your PBX is your organization's tenant in Cockpit. Every other entity is scoped to it, and there is one PBX per tenant.

Overview

Here you set the PBX's own configuration. Some of it is organization-wide defaults, and the rest applies only at the PBX level.

What it does

Values set here are PBX-wide defaults. Every group, user, and device inherits them unless it sets its own, so you configure a value once and override it only where it needs to differ.

Telephony changes are staged: saving does not apply your changes to live calls immediately. They take effect only when you click Push configuration, the button at the top of every Telephony page. This button shows the current state (up to date, changes pending, updating, or locked), lets you review what is pending, and logs every push. Use Lock push to lock the push configuration so no one can apply pending changes until you unlock it, preventing a premature push while work is still in progress. The lock records who set it.

Single Sign-On

Your users can sign in to Cockpit with their existing Microsoft or OpenID Connect account instead of a separate Cockpit password. The settings on the Authentication tab turn this on and control whether new users are created automatically. See the Set up Single Sign-On (SSO) guide for a step-by-step walkthrough, an explanation of each setting, and how Microsoft accounts create users and their extensions.

User provisioning

Your own system can keep Cockpit's users in sync over an API: you post the complete list of people who should exist, and Cockpit creates, updates, and removes accounts, extensions, twinnings, and badges to match it. The User provisioning tab holds the endpoint URL, the key that authenticates it, and the IP addresses allowed to use it. See the Set up user provisioning guide for the request shape, a worked example, and what the sync does and does not remove.

See also

Parts of this form, documented on their own pages.

Phone buttons A programmable key on a phone or SIP device that can be configured to perform a specific action with a single press. Buttons are set on the PBX, a group, a use… Caller identities A caller identity sets the outgoing phone number shown to the called party when a user makes an external call. AI features Toggle which AI capabilities are active for the PBX: call summaries, transcription, translation, keyword mapping, call tagging, and sentiment analysis. Set up single sign-on (SSO) Let your users sign in to Cockpit with their Microsoft or OpenID Connect account, and understand what each SSO setting does. Set up user provisioning Keep Cockpit users, extensions, twinnings and badges in sync from your own directory by posting the full user list to the provisioning endpoint. Identity providers Connect a PBX to an external authentication service so users can log in with their corporate credentials via Single Sign-On.

Form fields

Fields available in the create and edit forms.

Defaults

Name

The display name of your PBX, shown throughout the admin panel.

Comment

An optional note for your own reference.

Default call ring duration

How long a call rings (in seconds) before it is forwarded or dropped.

More detail

This is the default for all extensions unless overridden individually.

Music on hold

The sound file callers hear when placed on hold.

More detail

You can choose from your uploaded music-type sound files.

Ring tone pattern

The ring cadence for incoming calls on SIP devices.

More detail

Choose from country-specific patterns: Luxembourg, Germany, France, Belgium, Netherlands, USA, UK, Portugal, Switzerland, Austria, Italy, Spain, Bulgaria, or South Africa.

Outgoing call carrier

The SIP carrier used for outgoing calls by default, unless a more specific outgoing call route applies.

Outgoing call fallback carrier

A backup SIP carrier that takes over if the default carrier is unavailable.

Default internal call flow

The call flow used for internal calls between extensions within this PBX.

Default external call flow

The call flow used for incoming external calls when the dialled extension is found.

No extension match external call flow

The call flow that runs when an incoming external call does not match any extension.

More detail

If you leave this empty, the default external call flow is used instead.

Max channels

The maximum number of calls that can come in at the same time.

More detail

Once this limit is reached, additional callers hear the sound file configured below.

Sound file for max incoming channels

The announcement played to callers when all incoming channels are in use.

More detail

Choose from your uploaded announcement-type sound files.

IT admin notification email

The email address that receives system notifications from the PBX.

Reserved extensions

Comma-separated numbers that nobody can create as an extension on this PBX. Use it for numbers that must keep reaching what your telephony provider routes them to - typically the emergency and service numbers of your country - rather than ringing a desk.

More detail

Which numbers must stay free differs from country to country, so the list is yours to set. It is enforced everywhere an extension can be created: this admin panel, the user import, user provisioning, SCIM and single sign-on. Numbers already used by an extension are not removed for you - those extensions keep working until you delete them, they are flagged in the extensions list, and you will see a reminder after saving.

Default call pickups for new extensions

When turned on, every new extension is automatically added to the default call pickup group.

Display users as "First name Last name"

When on, names show as "First name Last name" instead of "Last name First name".

Capitalize users' last names

When turned on, last names are displayed in uppercase throughout the interface.

Show "via" in missed call notifications on phones

When turned on, the "via" line is shown in missed-call notifications on SIP phones.

Split internal and external calls for single line users

When a user has only one line, show separate internal and external lines.

Block calls from logged-out SIP devices

When turned on, roaming SIP devices that are not logged in to a user cannot place calls.

Phones / SIP devices

Automatic firmware updates

When turned on, phone firmware is updated automatically during provisioning.

Allow login

Allows users to log in to any SIP device with their extension credentials (hot-desking).

Tempus status

Shows Tempus presence status in client applications.

Enable LLDP

Enables LLDP so phones can automatically discover network settings like VLAN assignments.

VLAN PC

The default VLAN ID for the PC port on new phones.

More detail

Accepted values: 0 to 4096.

VLAN phone

The default VLAN ID for the phone port on new phones.

More detail

Accepted values: 0 to 4096.

Phone language

The display language for newly provisioned phones.

More detail

Choose English, German, or French.

Web admin password

The password for the web admin interface on SIP phones.

More detail

Leave it empty to keep the current one. Revealing the current password is logged in the change log.

Multicast sites IP addresses

IP addresses for multicast sites, used for paging and intercom across network segments.

More detail

You can add up to 5 entries.

Gigaset provisioning URL

The provisioning URL for Gigaset phones.

More detail

Read-only, generated from your PBX domain. Copy it into the phone's provisioning settings.

Gigaset phone directory URL

The phone directory URL for Gigaset devices.

More detail

Read-only. Copy it into the phone's online directories configuration.

Outgoing phone numbers

Outgoing phone numbers

Your outgoing phone numbers (caller identities) at the PBX level.

More detail

Each entry has a phone number, an optional extension suffix (use * as a wildcard for the actual extension number), and an optional label. You can drag entries to reorder them.

Authentication

SSO sign-in

Turns on Single Sign-On so your users can log in with their company credentials.

More detail

Enabling this reveals the SSO configuration fields below.

SSO type

The SSO protocol to use.

  • openid_connect OpenID Connect Generic OIDC provider.
  • microsoft Microsoft Microsoft Entra ID (Azure AD). Users sign in with the Microsoft account your organization issued them.
More detail

Visible only when SSO is enabled.

Force SSO sign-in on Cockpit

When turned on, users must sign in through SSO. Signing in with a Cockpit password is no longer possible.

More detail

Visible only when SSO is enabled.

SSO provisioning

When turned on, Cockpit creates a user account and its extension automatically the first time someone signs in via SSO, and keeps them in sync on each sign-in. When off, only people who already have a Cockpit account can sign in, and Cockpit never creates or changes accounts from the provider.

More detail

Applies to both SSO types (Microsoft and OpenID Connect). Requires at least one identity provider email domain below so Cockpit can match a new user to this PBX. Exactly who is allowed to be created, and which roles they receive, depends on the SSO type - see the Single Sign-On setup guide for details. Visible only when SSO is enabled.

Identity providers

Your identity provider settings (client ID, secret, discovery URL, and related endpoints).

More detail

For OpenID Connect: name, description, status, client ID, client secret, discovery URL, authorization URL, token URL, userinfo URL, logout URL, and issuer. For Microsoft: only the tenant ID is needed. You can configure one provider.

Identity provider email domains

Email domains used to map a newly provisioned SSO user to this PBX.

More detail

Required and visible only when SSO provisioning is enabled. A new user whose email matches one of these domains is created in this PBX. You can add multiple domains.

SSO identity field mapping

Maps claims from your OpenID Connect provider to user fields in the PBX (for example, email, first name, last name, extension).

More detail

You can define up to 5 mappings. Visible for OpenID Connect providers (whether or not SSO provisioning is enabled): the mapping is used on every sign-in to read the email and name claims that match and update the user. Microsoft accounts use a fixed, documented schema, so no mapping is needed.

User provisioning

User provisioning URL

The SCIM API endpoint for automatic user provisioning.

More detail

Read-only. Copy it into your identity provider's provisioning configuration.

User provisioning key

The secret API key for authenticating provisioning requests.

More detail

You can regenerate it using the refresh button. Regenerating invalidates the previous key immediately.

User provisioning IP addresses

The IP addresses allowed to call the provisioning API. Requests from other IPs are rejected.

More detail

You can add up to 5 entries.

Voxbi apps

Show all users in Voxbi

When turned on, every PBX user is visible in the Voxbi app regardless of group membership.

Enable Tempus menu

Shows the Tempus time-tracking menu in Voxbi client apps.

Call recordings and AI

Allow call recording

Shows whether call recording is enabled for this PBX.

More detail

Managed at the platform level. Cannot be changed here.

Allow users to stop/start recording

When turned on, users can start and stop recording during a call from their device.

Destination for recordings

Where recordings are stored.

  • customer Customer Customer-managed storage.
  • mixvoip Mixvoip Platform-managed storage.
Start the recording

When recording begins.

  • on_start When the call starts Captures ringing and the conversation.
  • on_bridge When the call has been answered by a phone Captures only the conversation.
AI profile

The AI profile assigned to your PBX, which determines which AI features are available.

More detail

Managed at the platform level by Voxbi support. Shown here for reference only.

AI features

AI features enabled for this PBX, such as call summaries, transcription, translations, keyword mapping, call tagging, and sentiment analysis.

More detail

Which features you can toggle depends on the AI profile assigned to your PBX.

Transcript retention (days)

AI Assistant transcripts older than this are purged automatically to comply with GDPR.

More detail

Leave blank to use the platform default. Set to 0 to disable automated purging.

Phone buttons

Phone buttons

The default phone buttons for all SIP devices on this PBX.

More detail

Inherited by every phone. Can be overridden at the group, user, or device level.

Branding

Voxbi apps

Logos shown in the Voxbi desktop app. Upload PNG, JPG, JPEG, or SVG up to 10 MB.

Yealink wallpapers

Background wallpapers pushed to Yealink phones. Upload PNG, JPG, JPEG, or SVG up to 10 MB.

More detail

Beta. Only appears when the feature is enabled for your PBX.

Updated