Skip to content
Voxbi Cockpit APIs
API Guides

PBXs

A PBX is a private telephone system provisioned through the partner portal, scoped to a single partner and independently administered by its own admin user.

Overview

Each PBX belongs to a partner (distributor or reseller) and holds its own users, extensions, and telephony configuration. Distributors see PBXs across all their resellers, resellers see only their own. Administrators are optional when you create a PBX: enter an email address, and optionally a first and last name, and each person receives an invitation email. Names are prefilled on their setup page, and you can invite more administrators later from the PBX edit form. The sign-in action opens the PBX admin panel directly without needing an administrator's credentials.

A PBX does not have to be deployed when you create it. Switch Deploy this PBX off and the PBX exists but runs on no server yet; the list shows Not deployed in its Server column, and the Not deployed filter narrows the list to those PBXs. Open the PBX, switch Deploy this PBX on and save to deploy it. Once a PBX is deployed, it cannot be undeployed from here.

The Server column also tells you whether the server is actually running the PBX. A grey Waiting for the server chip means the PBX is assigned but the server has not applied its configuration yet. A green Deployed chip means it has; the line below shows the server and the date and time it did so, and an Update pending chip means a newer configuration is on its way to the server. The server name is only shown for servers your account may use. Use the Server filter to show only the PBXs on one or more of the servers your account may use.

Activating Tempus

The Tempus tab on a PBX turns the time and attendance module on or off for that PBX. Activating it is two steps in one place: switch Tempus activated on, then pick the users who should be able to use it - the selected users receive the HR role, and only users with that role can open Tempus.

Switching Tempus off asks what should happen to the HR role: keep it on the users who have it (they simply lose access while Tempus is off), or remove it from every user of the PBX. Either way, the role alone never grants access while Tempus is deactivated.

Linking existing PBXs

Resellers whose account is enabled for bulk linking get a Find and link existing PBXes button on the PBX list. It opens a page with two ways to claim a PBX that already exists in the system.

Search by instance name. Paste or type at least two characters of an instance name. Every PBX whose instance name contains that fragment is listed (up to 50), each with its current status:

  • Will assign - the PBX belongs to no partner yet. The Link button assigns it to you.
  • Already on this reseller - nothing to do.
  • Owned by another partner - there is no Link button. The owning partner is not named, on either path. Taking a PBX away from another partner is only possible through the CSV path below, which asks you to confirm each reassignment individually.

Bulk-link from a CSV. Upload a comma-separated file whose header contains an instance_name column. The preview screen groups every row by the same statuses, counts what will change, and lets you tick the PBXs currently owned by another partner that you want reassigned. Nothing is written until you confirm on that screen.

See also

  • Resellers - distributors can assign a PBX to a specific reseller.
  • Customers - optionally link a PBX to a customer record.
  • Team - the sign-into-PBX permission is managed on team member roles.

Form fields

Fields available in the create and edit forms.

General

Name

Display name of the PBX, shown in lists and the PBX admin panel.

Instance name

Unique technical identifier for the PBX. Set during creation and cannot be changed afterwards.

Trunk username

SIP trunk username for this PBX. Defaults to the instance name if left empty.

Customer

Optional. Customer this PBX belongs to. Only customers in your organization are shown.

Reseller

Reseller this PBX is assigned to. Only visible for distributors.

Deploy this PBX

When off, the PBX is created but not deployed to any server, and shows as Not deployed in the list. Open the PBX later and switch this on to deploy it. A deployed PBX cannot be undeployed.

Manual server selection

When on, you pick the deployment server from the servers your account may use. When off, the system assigns the least loaded of those servers automatically.

Server

Server to deploy this PBX on, showing current load (PBXs, users, devices). Only servers your account may use are listed. Leave empty to auto-assign.

Cockpit administrators

Optional. Email address and optional first and last name of each person who will administer this PBX, up to 10. Each one receives an invitation email with a link that is valid for 7 days.

Allow phone number requests

Lets this PBX order new phone numbers from its own Phone number requests screen. Off for every PBX unless you turn it on; a customer who signed up through the onboarding funnel gets it automatically.

Tempus

Tempus activated

Turns the Tempus time and attendance module on or off for this PBX. When off, nobody on this PBX can open Tempus.

Choose users with HR role so they can access Tempus

The selected users receive the HR role. Without that role a user cannot access Tempus.

What should happen to the HR role?

When deactivating Tempus, either keep the HR role on the users who have it, or remove it from every user of this PBX.

Updated