Skip to content
Voxbi Cockpit APIs
API Guides

Contacts

A contact is a named external person or company with one or more phone numbers. The PBX matches incoming caller IDs against the contact list and surfaces the contact's name, company, and VIP status on the answering phone.

Overview

Contacts make the difference between "Anonymous caller" and "John Smith - Acme Corp" on the answering user's screen. They are an inbound-side feature: a contact needs at least one phone number to be matched, and beyond identification they drive two optional behaviors.

  • Global block - reject all of a contact's inbound calls tenant-wide.
  • Handling strategy - route a contact's calls to a specific destination instead of the called number's normal flow.

Contacts can be shared across the tenant or private to one user. Shared contacts require the manage global contacts permission.

What it does

The handling strategy overrides routing when the contact calls in from outside (internal calls are unaffected).

Strategy When to use
Default Identification only, no routing change. The standard case for almost all contacts.
Call flow Multi-step routing for important contacts, for example a VIP greeting then a priority queue.
Extension Send the contact straight to a specific desk regardless of the number they dialled.
User VIP-to-account-manager routing. The user's phones, twinning, and DND rules apply.
SIP device Route to a shared phone or kiosk not owned by one user.

The VIP flag lets a contact bypass Do not disturb on the called user. It requires the user to also hold the VIP permission, granted by an administrator.

See also

  • Phone numbers - the DIDs whose default routing the contact handling strategy overrides.
  • Call flows - the routing destination for the Call flow handling strategy.
  • Users - the VIP permission lives on the user receiving the call.

Form fields

Fields available in the create and edit forms.

General

First name API name1

The contact's first name. At least one name field is required.

Last name API name2

The contact's last name.

VIP

Marks the contact as VIP. When on, this contact can ring through Do not disturb on the receiving user, provided that user also holds the VIP permission.

E-mail API email

The contact's email address, shown in call history.

Company name API company_name

The company or organization the contact belongs to. Shown on the answering phone and in list filters.

Visible only to these groups API groups

When groups are selected, this contact is only visible to users in those groups. Leave empty to make the contact visible to everyone.

Phone numbers API contactPhoneNumbers

Phone numbers for this contact. Each number has a type, an optional label, an optional speed dial code, and an optional call flow for routing incoming calls from that number.

Department API department

The department within the contact's organization. Shown in list filters.

Job title API job_title

The contact's job title or role.

Notes API notes

Free-text notes about the contact for your own reference.

Caller blocked

When on, all incoming calls from this contact's phone numbers are rejected system-wide.

Incoming call handling

How incoming calls from this contact are handled. Default means no override. Other options route the call to a specific call flow, extension, user, or SIP device.

Call flow

The call flow to route calls from this contact to when handling strategy is set to Call flow.

Extension

The extension to route calls from this contact to when handling strategy is set to Extension.

User

The user to route calls from this contact to when handling strategy is set to User.

Phone / SIP device

The SIP device to route calls from this contact to when handling strategy is set to SIP device.

Updated