Skip to content
Voxbi Cockpit APIs
API Guides

Tags

A tag is a flexible label you stick on users and SIP devices to group them by any axis your tenant cares about. Tags overlap freely: one user can carry as many as you like, which is exactly what a group cannot do.

Overview

A tag is the "and also" dimension. Where Groups carve users into mutually-exclusive teams (one group per user), tags overlap freely - a user might carry senior, English-speaking, on-call-rotation, and VIP-support at once. You decide what each tag means.

What it does

A tag does not affect callers directly. It affects who gets the call when a routing entity filters by tag. Tags become routing-relevant when consumed by:

  • Pools - both Include and Filter phases accept tags as a criteria type.
  • Multicasts - target everyone with a given tag.
  • Call flow steps - the Dial step type can target tags.

Editing a tag's membership takes effect on the next routing evaluation - there is no need to re-save the consuming pool, multicast, or step.

See also

Form fields

Fields available in the create and edit forms.

General

Name API name

The display name of the tag. Must be unique within your PBX. Use lowercase-with-dashes (for example, on-call or vip-support) to avoid case-sensitivity issues.

Comment API description

Optional note describing the purpose of this tag and when to apply it.

Users API users

Users assigned to this tag. Tagged users can be targeted together in call flows, pools, and other routing configurations.

SIP devices

SIP devices API sipDevices

SIP devices assigned to this tag. Grouping devices under a tag makes it easier to manage them in bulk and filter them in lists.

Updated