Bicom PBXware API

The common uses are a new starter or a leaver on a phone ticket, a change to a ring group, an IVR or opening hours, a call quality complaint, and a ticket opened from a transcribed helpdesk call.

Automatically enabled when you configure Bicom PBXware permissions in your agent workflow.

What It Does

Create, change and remove extensions and their enhanced services: call forwarding, do not disturb, caller ID, follow me
Change IVRs, ring groups, enhanced ring groups and their members, dial and paging groups, DIDs and opening hours
Read call detail records with their MOS call quality, live calls, SIP registrations, and queue and ring group statistics
Read the transcript and summary PBXware made of a call, and ask PBXware to transcribe one
Place, transfer and record calls, and send SMS
Manage departments, contacts, phones and emergency buttons
Manage PBXware’s AI voice agents, tenants, tenant packages, service plans, trunks, server settings and web hooks

It uses PBXware’s API v2 (PBXware 8.1 or later) and its legacy API, each with its own key; see Connecting Bicom PBXware.

Permission Groups

Group	Covers
Call History, Live Calls and Statistics	Call detail records with MOS, live calls, SIP registrations and extensions online, queue and ring group statistics, SMS reports, call archives (read only)
Call Transcripts and Transcription Settings	Call transcripts and summaries and asking for one, post-call, voicemail and live transcription settings, live transcription streams
Placing, Transferring and Recording Calls, and SMS	Placing, hanging up and transferring calls, call recording, SMS numbers and sending SMS
Extensions, Departments and Contacts	Extensions and their settings, voicemail and enhanced services, departments, contacts, app editions
IVRs, Ring Groups, Queues, DIDs and Opening Hours	IVRs, ring groups, enhanced ring groups, dial and paging groups, DIDs and DID groups, CLI routing, operation times, greetings and hold music
Phones and Emergency Buttons	Phones (UADs) and their activation, emergency alarm buttons
AI Voice Agents and AI Providers	AI voice agents with their MCP servers and call logs, AI providers, text-to-speech
Tenants, Packages, Service Plans and Balances	Tenants, tenant packages, service plans and rates, extension balances and call rating
Trunks, Server Settings and Web Hooks	Trunks and SIP providers, SMS trunks, server settings and health, the licence, outbound routes, number lookup, voicemail settings, web hooks

Access Profiles

Profile	What runs on its own	What asks a technician
Read Only	Every read	No write is allowed
Helpdesk	Every read outside the two groups it turns off: Placing, Transferring and Recording Calls, and SMS, and AI Voice Agents and AI Providers	Every change to extensions, call routing and phones; no other write is allowed
IT Admin	Every read, and changes to extensions, call routing, phones and transcripts outside Safety Controls	Calls and SMS, AI voice agents, tenants and billing, trunks and the server, and the changes in Safety Controls
Full Automation	Every read and write outside Safety Controls	The changes in Safety Controls

Safety Controls

Control	Behavior
Always asks	Deleting a tenant; any change that points PBXware at an address outside it, where call data, audio or a stored key then flows (a web hook or its test, an MCP server, an AI provider, a live transcription stream or a channel added to it, the number lookup, a trunk’s host or proxy, the address validation URL); updating an AI provider; setting a SIP secret, PIN, password or key, and any change to how PBXware authenticates (an extension’s authentication settings, a trunk’s `insecure` option, IP authentication, two-factor and SSO settings), always ask a technician, whatever the profile
Each ticket stays with its client	On a ticket that names a company, Neo sends a call only in the PBXware tenant that company is mapped to. Calls on the whole server are left to chats and scheduled runs
Never	Neo never uploads the contacts CSV or the STIR/SHAKEN certificates
Credentials in answers	Neo removes SIP secrets, PINs, passwords, API keys and web hook logins from every answer before the agent reads it
Updates keep what they leave out	Before an API v2 update that replaces a record (contacts, operation times, AI voice agents, web hooks, emergency buttons), Neo reads the record and fills in each field the update leaves out, secrets included. A new extension’s SIP secret, and its PIN on the legacy API, are set by Neo and never shown

Getting started

Core

Triggered & Scheduled Agents

Chat Agents

Integrations

Product

Workflows

Customizing Neo

What It Does

Permission Groups

Access Profiles

Safety Controls

​What It Does

​Permission Groups

​Access Profiles

​Safety Controls

What It Does

Permission Groups

Access Profiles

Safety Controls