Skip to content
Docs
Voxbi Cockpit APIs
API Guides

Groups

A group is a named collection of users the rest of the system can target as one team. Each user belongs to exactly one group at a time, which is the line between a group and a tag.

Overview

A group is how you organize people into teams like Sales, Support, or Reception. Each user belongs to one group at a time. Groups act as routing targets across the system - queue members, multicast destinations, and Dial group call flow steps - so you can address a whole team at once.

What it does

Beyond routing, a group can carry its own default call flows, outgoing caller identities, a shared contacts address book, phone buttons cascaded to every member's device, and a pickup scope so members can answer each other's ringing phones. Defaults set on the group are used instead of the PBX defaults, and adding a user to a group moves them out of their previous one.

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 prompts Free-text instructions attached to one extension or group, telling the AI how to handle calls for that target instead of following the PBX-wide prompt.

Form fields

Fields available in the create and edit forms.

General

Name API name

The display name of this group, shown throughout the system when selecting or referencing it.

Comment API description

An optional note about this group. You can edit this directly from the list view.

Default internal call flow for group users API defaultInternalCallFlow

The call flow used by default for internal incoming calls to users in this group. Overrides the PBX-level default.

Default external call flow for group users API defaultExternalCallFlow

The call flow used by default for external incoming calls to users in this group. Overrides the PBX-level default.

Users API users

The users who belong to this group. Each user can only belong to one group at a time.

Allow group call pickups API allow_call_pickups

When turned on, members of this group can pick up ringing calls from other group members by dialing the pickup code.

Allow managing group contacts for other users API allowManageGroupContacts

Users who are allowed to create, edit, and delete contacts that belong to this group.

Allow visibility to group contacts for other users API allowAccessToGroupContacts

Users who can see and search the group's shared contacts without the ability to modify them.

Outgoing phone numbers

Allow default outgoing phone numbers API allow_default_pbxes_outgoing_phone_numbers

When turned on, the PBX-level default outgoing phone numbers are available to users in this group alongside any group-specific phone numbers.

Extension shown outside the group

The extension number shown to external parties when a group member makes an outgoing call through the group's phone numbers.

Phone numbers API callerIdentities

The outgoing phone numbers available to users in this group. Each entry maps a phone number with an optional extension suffix and label.

Default caller identity

The default outgoing caller identity used when a group member makes an external call. If not set, the PBX default is used.

Voxbi apps

Display this group to everyone API display_tab_to_everyone_inside_voxbi

When turned on, this group appears as a tab visible to all users in the Voxbi application.

Display to the following users

Specific users who will see this group as a tab in their Voxbi application, regardless of the global visibility setting.

Display to the following groups

Members of these groups will see this group as a tab in their Voxbi application.

Phone buttons

Phone buttons

Phone buttons configured at the group level. These buttons are inherited by all SIP devices of users in this group.

AI prompt

Prompt

Instructions the AI follows when handling calls for this group. Leave empty to remove the prompt. Only shown when the PBX is on an AI plan.

Updated