Every 3CX Configuration API (XAPI) object in one Go binary, with a local mirror of your whole PBX, offline search, config diffing, and cross-entity auditing no 3CX tool has.
Covers the full 3CX V20+ Configuration API: users, groups, ring groups, queues, IVRs, trunks, DIDs, in/outbound rules, reporting, backups, security, and integrations. Beyond CRUD, it mirrors the entire config graph into local SQLite so you can search it offline, diff it over time, audit it for dangling references, roll up queue and agent performance, and trace exactly what routes to an extension.
Created by @therichardgill (Richard Gill).
Contributors: @tmchow (Trevin Chow).
Authentication
Authentication is OAuth2 client-credentials. Create an API client in the 3CX Web Client under Admin > Integrations > API, enable the 3CX Configuration API checkbox, and assign the Service Principal the System Owner role (System Administrator causes 403 on call history and several reports). Set TCX_CLIENT_ID and TCX_CLIENT_SECRET, and point the CLI at your instance with TCX_FQDN (or the base-url config). The CLI mints and caches a Bearer token from /connect/token and refreshes it automatically (tokens last 60 minutes).
Quick Start
# Health check: confirms config and auth wiring before any live call.
3cx-xapi-pp-cli doctor --dry-run
# Mirror the core config graph into local SQLite, the basis for search, audit, diff, and trace.
3cx-xapi-pp-cli sync --resources users,groups,ring-groups,queues,trunks,inbound-rules,did-numbers
# Instant offline lookup once synced.
3cx-xapi-pp-cli search 214 --type users --data-source local
# Find broken routing: destinations pointing at deleted or disabled objects.
3cx-xapi-pp-cli audit --agent
# Cross-queue performance and SLA rollup for the last week.
3cx-xapi-pp-cli qrollup --since 7d --agent
Unique Features
These capabilities aren't available in any other tool for this API.
Config graph intelligence
-
audit — Flag every ring group, queue, inbound/outbound rule, and IVR destination that points at a deleted, disabled, or non-existent extension or DID.
Reach for this to catch broken call routing before users do, surfacing dangling references the 3CX console cannot detect.
3cx-xapi-pp-cli audit --agent
-
diff — Capture the full PBX config to a local snapshot, then show exactly what changed between two points in time or two tenants.
Reach for this for change management, proving what changed, when, and by how much across the whole config.
3cx-xapi-pp-cli diff yesterday now --agent
-
posture — Consolidate blocklist, blacklisted numbers, anti-hacking settings, firewall state, failed-auth events, and the admin audit log into one attack-surface report.
Reach for this for a one-shot security review instead of hunting across Security and Logs screens.
3cx-xapi-pp-cli posture --agent
-
trace — For one extension, show every inbound rule, ring group, queue, DID, and forwarding profile that routes to it.
Reach for this to answer why an extension is not ringing by seeing every path that reaches it.
3cx-xapi-pp-cli trace 214 --agent
Bulk operations
-
provision — Idempotently create extensions and users from a CSV, assigning groups and roles, with a dry-run plan and typed exit codes.
Reach for this to onboard a whole tenant in one command instead of clicking the web console per extension.
3cx-xapi-pp-cli provision --file users.csv --dry-run
Contact-centre analytics
-
qrollup — One cross-queue table joining queue performance, agent-in-queue stats, abandoned calls, and SLA breaches over a time window.
Reach for this to compare queues and weeks at a glance instead of opening one slow report screen per queue.
3cx-xapi-pp-cli qrollup --since 7d --agent
Local state that compounds
-
search — Instant full-text search across the mirrored config graph (users, groups, ring groups, queues, trunks, DIDs, contacts) by number, name, email, or extension.
Reach for this when you know a number or name and need the object fast, across every entity type at once.
3cx-xapi-pp-cli search reception --type users --data-source local --agent
-
changed — A single time-windowed feed merging activity log, event log, active calls, and system status into the state of the PBX now or since a given time.
Reach for this as the first command when triaging something wrong right now on a PBX.
3cx-xapi-pp-cli changed --since 2h --agent
Recipes
Audit broken call routing
3cx-xapi-pp-cli audit --agent
After a sync, lists every ring group, queue, rule, and IVR destination that no longer resolves to a live extension or DID.
Narrow a verbose Users listing for an agent
3cx-xapi-pp-cli users list --agent --select Number,FirstName,LastName,Groups.Name
Users responses are deeply nested; --select with dotted paths returns only the fields an agent needs, saving context.
Provision a tenant from CSV (safe preview)
3cx-xapi-pp-cli provision --file new-extensions.csv --dry-run
Shows the exact create and update plan with no writes; drop --dry-run to apply idempotently.
Trace why an extension is not ringing
3cx-xapi-pp-cli trace 214 --agent
Shows every inbound rule, ring group, queue, DID, and forwarding profile that routes to extension 214.
Weekly queue SLA review
3cx-xapi-pp-cli qrollup --since 7d --agent
One cross-queue table of performance, abandoned calls, and SLA breaches for the week.
Usage
Run 3cx-xapi-pp-cli --help for the full command reference and flag list.
Paths & environment variables
This CLI separates local files into four path kinds:
| Kind | Contents |
|---|
config | User-editable settings such as config.toml and saved profiles |
data | Durable local data: credentials.toml, data.db, cookies, browser-session proof files, and other auth sidecars |
state | Runtime state such as persisted queries, jobs, and teach.log |
cache | Regenerable HTTP/cache files |
Each kind resolves independently. The ladder is:
- Per-kind env var:
API_3CX_XAPI_CONFIG_DIR, API_3CX_XAPI_DATA_DIR, API_3CX_XAPI_STATE_DIR, or API_3CX_XAPI_CACHE_DIR
--home <dir> for this invocationAPI_3CX_XAPI_HOME for a flat relocated root- XDG env vars:
XDG_CONFIG_HOME, XDG_DATA_HOME, XDG_STATE_HOME, XDG_CACHE_HOME
- Platform defaults matching existing installs
For containers and agent sandboxes, prefer a single relocated root:
export API_3CX_XAPI_HOME=/srv/3cx-xapi
3cx-xapi-pp-cli doctor
Under API_3CX_XAPI_HOME=/srv/3cx-xapi, the four dirs resolve to /srv/3cx-xapi/config, /srv/3cx-xapi/data, /srv/3cx-xapi/state, and /srv/3cx-xapi/cache.
MCP servers do not receive CLI flags from the host. Put relocation in the host env block:
{
"mcpServers": {
"3cx-xapi": {
"command": "3cx-xapi-pp-mcp",
"env": {
"API_3CX_XAPI_HOME": "/srv/3cx-xapi"
}
}
}
}
Precedence matters in fleets: an ambient per-kind variable such as API_3CX_XAPI_DATA_DIR overrides an explicit --home for that kind. Use API_3CX_XAPI_HOME or the per-kind variables for durable fleet relocation; treat --home as the weaker per-invocation lever.
Relocation is one-way. Unsetting API_3CX_XAPI_HOME does not move files back to platform defaults, and doctor cannot find credentials left under a former root. Move the files manually before unsetting relocation variables.
Existing installs keep working because the platform-default rung matches the legacy layout. On the first auth write, stored secrets leave config.toml and are consolidated into credentials.toml under the data directory. Run 3cx-xapi-pp-cli doctor --fail-on warn to check path and credential-location warnings in automation.
Commands
active-calls
Manage active calls
3cx-xapi-pp-cli active-calls - Get entities from ActiveCalls
active-calls-id
Manage active calls id
3cx-xapi-pp-cli active-calls-id <Id> - Invoke action DropCall
activity-log
Manage activity log
3cx-xapi-pp-cli activity-log get-filter - Invoke function GetFilter3cx-xapi-pp-cli activity-log get-logs - Invoke function GetLogs3cx-xapi-pp-cli activity-log purge-logs - Invoke action PurgeLogs
aisettings
Manage aisettings
3cx-xapi-pp-cli aisettings add-vector-store-files - Invoke action AddVectorStoreFiles3cx-xapi-pp-cli aisettings create-vector-store - Invoke action CreateVectorStore3cx-xapi-pp-cli aisettings delete-open-ai-file - Invoke action DeleteOpenAiFile3cx-xapi-pp-cli aisettings delete-vector-store - Invoke action DeleteVectorStore3cx-xapi-pp-cli aisettings delete-vector-store-file - Invoke action DeleteVectorStoreFile3cx-xapi-pp-cli aisettings get - Get AISettings3cx-xapi-pp-cli aisettings get-airesources - Invoke function GetAIResources3cx-xapi-pp-cli aisettings get-aitemplate-contents - Invoke function GetAITemplateContents3cx-xapi-pp-cli aisettings get-vector-store - Invoke function GetVectorStore3cx-xapi-pp-cli aisettings get-vector-store-files - Invoke function GetVectorStoreFiles3cx-xapi-pp-cli aisettings get-vector-stores - Invoke function GetVectorStores3cx-xapi-pp-cli aisettings update - Update AISettings3cx-xapi-pp-cli aisettings update-vector-store - Invoke action UpdateVectorStore
amazon-integration-settings
Manage amazon integration settings
3cx-xapi-pp-cli amazon-integration-settings generate-iam-policy-file - Invoke function GenerateIamPolicyFile3cx-xapi-pp-cli amazon-integration-settings get - Get AmazonIntegrationSettings3cx-xapi-pp-cli amazon-integration-settings update - Update AmazonIntegrationSettings
anti-hacking-settings
Manage anti hacking settings
3cx-xapi-pp-cli anti-hacking-settings get - Get AntiHackingSettings3cx-xapi-pp-cli anti-hacking-settings update - Update AntiHackingSettings
backups
Manage backups
3cx-xapi-pp-cli backups backup - Invoke action Backup3cx-xapi-pp-cli backups get-can-create - Invoke function GetCanCreateBackup3cx-xapi-pp-cli backups get-failover-scripts - Invoke function GetFailoverScripts3cx-xapi-pp-cli backups get-failover-settings - Invoke function GetBackupFailoverSettings3cx-xapi-pp-cli backups get-local-size - Invoke function GetLocalBackupSize3cx-xapi-pp-cli backups get-repository-settings - Invoke function GetBackupRepositorySettings3cx-xapi-pp-cli backups get-restore-settings - Invoke function GetRestoreSettings3cx-xapi-pp-cli backups get-settings - Invoke function GetBackupSettings3cx-xapi-pp-cli backups list - Get entities from Backups3cx-xapi-pp-cli backups purge-local - Invoke action PurgeLocalBackups3cx-xapi-pp-cli backups set-failover-settings - Invoke action SetBackupFailoverSettings3cx-xapi-pp-cli backups set-repository-settings - Invoke action SetBackupRepositorySettings3cx-xapi-pp-cli backups set-restore-settings - Invoke action SetRestoreSettings3cx-xapi-pp-cli backups set-settings - Invoke action SetBackupSettings
backups-file-name
Manage backups file name
3cx-xapi-pp-cli backups-file-name delete-backups - Delete entity from Backups3cx-xapi-pp-cli backups-file-name get-backup-extras - Invoke function GetBackupExtras3cx-xapi-pp-cli backups-file-name restore - Invoke action Restore
black-list-numbers
Manage black list numbers
3cx-xapi-pp-cli black-list-numbers bulk-numbers-delete - Invoke action BulkNumbersDelete3cx-xapi-pp-cli black-list-numbers create - Add new entity to BlackListNumbers3cx-xapi-pp-cli black-list-numbers list - Get entities from BlackListNumbers
black-list-numbers-id
Manage black list numbers id
3cx-xapi-pp-cli black-list-numbers-id delete-black-list-number - Delete entity from BlackListNumbers3cx-xapi-pp-cli black-list-numbers-id get-black-list-number - Get entity from BlackListNumbers by key3cx-xapi-pp-cli black-list-numbers-id update-black-list-number - Update entity in BlackListNumbers
blocklist
Manage blocklist
3cx-xapi-pp-cli blocklist bulk-ips-delete - Invoke action BulkIpsDelete3cx-xapi-pp-cli blocklist create-addr - Add new entity to Blocklist3cx-xapi-pp-cli blocklist list-addr - Get entities from Blocklist
blocklist-id
Manage blocklist id
3cx-xapi-pp-cli blocklist-id delete-blocklist-addr - Delete entity from Blocklist3cx-xapi-pp-cli blocklist-id get-blocklist-addr - Get entity from Blocklist by key3cx-xapi-pp-cli blocklist-id update-blocklist-addr - Update entity in Blocklist
call-cost-settings
Manage call cost settings
3cx-xapi-pp-cli call-cost-settings export-call-costs - Invoke function ExportCallCosts3cx-xapi-pp-cli call-cost-settings list - Get entities from CallCostSettings3cx-xapi-pp-cli call-cost-settings update-cost - Invoke action UpdateCost
call-flow-apps
Manage call flow apps
3cx-xapi-pp-cli call-flow-apps create - Add new entity to CallFlowApps3cx-xapi-pp-cli call-flow-apps list - Get entities from CallFlowApps
call-flow-apps-id
Manage call flow apps id
3cx-xapi-pp-cli call-flow-apps-id delete-call-flow-app - Delete entity from CallFlowApps3cx-xapi-pp-cli call-flow-apps-id delete-file - Invoke action DeleteFile3cx-xapi-pp-cli call-flow-apps-id get-call-flow-app - Get entity from CallFlowApps by key3cx-xapi-pp-cli call-flow-apps-id get-files - Invoke function GetFiles3cx-xapi-pp-cli call-flow-apps-id update-call-flow-app - Update entity in CallFlowApps
call-flow-scripts
Manage call flow scripts
3cx-xapi-pp-cli call-flow-scripts - Get entities from CallFlowScripts
call-history-view
Manage call history view
3cx-xapi-pp-cli call-history-view download-call-history - Invoke function DownloadCallHistory3cx-xapi-pp-cli call-history-view list - Get entities from CallHistoryView
call-parking-settings
Manage call parking settings
3cx-xapi-pp-cli call-parking-settings get - Get CallParkingSettings3cx-xapi-pp-cli call-parking-settings update - Update CallParkingSettings
call-types-settings
Manage call types settings
3cx-xapi-pp-cli call-types-settings get - Get CallTypesSettings3cx-xapi-pp-cli call-types-settings update - Update CallTypesSettings
cdrsettings
Manage cdrsettings
3cx-xapi-pp-cli cdrsettings get - Get CDRSettings3cx-xapi-pp-cli cdrsettings update - Update CDRSettings
chat-history-view
Manage chat history view
3cx-xapi-pp-cli chat-history-view download-chat-history - Invoke function DownloadChatHistory3cx-xapi-pp-cli chat-history-view list - Get entities from ChatHistoryView
chat-log-settings
Manage chat log settings
3cx-xapi-pp-cli chat-log-settings get - Get ChatLogSettings3cx-xapi-pp-cli chat-log-settings update - Update ChatLogSettings
chat-messages-history-view
Manage chat messages history view
3cx-xapi-pp-cli chat-messages-history-view download-chat-messages-history - Invoke function DownloadChatMessagesHistory3cx-xapi-pp-cli chat-messages-history-view list - Get entities from ChatMessagesHistoryView
codecs-settings
Manage codecs settings
3cx-xapi-pp-cli codecs-settings get - Get CodecsSettings3cx-xapi-pp-cli codecs-settings update - Update CodecsSettings
conference-settings
Manage conference settings
3cx-xapi-pp-cli conference-settings delete-api-key - Invoke action DeleteApiKey3cx-xapi-pp-cli conference-settings generate-api-key - Invoke function GenerateApiKey3cx-xapi-pp-cli conference-settings get - Get ConferenceSettings3cx-xapi-pp-cli conference-settings get-mcurequest-status - Invoke function GetMCURequestStatus3cx-xapi-pp-cli conference-settings get-mcurow - Invoke function GetMCURow3cx-xapi-pp-cli conference-settings get-mcurows - Invoke function GetMCURows3cx-xapi-pp-cli conference-settings get-onboard-mcu-data - Invoke function GetOnboardMcuData3cx-xapi-pp-cli conference-settings get-onboard-meetings - Invoke function GetOnboardMeetings3cx-xapi-pp-cli conference-settings get-web-meeting-zones - Invoke function GetWebMeetingZones3cx-xapi-pp-cli conference-settings update - Update ConferenceSettings3cx-xapi-pp-cli conference-settings update-mcurequest-status - Invoke action UpdateMCURequestStatus
console-restrictions
Manage console restrictions
3cx-xapi-pp-cli console-restrictions get - Get ConsoleRestrictions3cx-xapi-pp-cli console-restrictions update - Update ConsoleRestrictions
contacts
Manage contacts
3cx-xapi-pp-cli contacts create - Add new entity to Contacts3cx-xapi-pp-cli contacts create-by-number - Invoke action CreateContactByNumber3cx-xapi-pp-cli contacts delete-by-id - Invoke action DeleteContactsById3cx-xapi-pp-cli contacts delete-by-type - Invoke action DeleteContactsByType3cx-xapi-pp-cli contacts delete-department-by-type - Invoke action DeleteDepartmentContactsByType3cx-xapi-pp-cli contacts delete-personal-by-type - Invoke action DeletePersonalContactsByType3cx-xapi-pp-cli contacts get-by-number - Invoke function GetContactsByNumber3cx-xapi-pp-cli contacts get-dir-search-settings - Invoke function GetDirSearchSettings3cx-xapi-pp-cli contacts list - Get entities from Contacts3cx-xapi-pp-cli contacts set-dir-search-settings - Invoke action SetDirSearchSettings
contacts-id
Manage contacts id
3cx-xapi-pp-cli contacts-id delete-contact - Delete entity from Contacts3cx-xapi-pp-cli contacts-id get-contact - Get entity from Contacts by key3cx-xapi-pp-cli contacts-id update-contact - Update entity in Contacts
countries
Manage countries
3cx-xapi-pp-cli countries - Get entities from Countries
country-codes
Manage country codes
3cx-xapi-pp-cli country-codes get - Get CountryCodes3cx-xapi-pp-cli country-codes update - Update CountryCodes
crm-integration
Manage crm integration
3cx-xapi-pp-cli crm-integration delete-crm-contacts - Invoke action DeleteCrmContacts3cx-xapi-pp-cli crm-integration get - Get CrmIntegration3cx-xapi-pp-cli crm-integration get-crm-template-source - Invoke function GetCrmTemplateSource3cx-xapi-pp-cli crm-integration get-oauth - Invoke function GetOAuth3cx-xapi-pp-cli crm-integration set-oauth-state - Invoke action SetOAuthState3cx-xapi-pp-cli crm-integration test - Invoke action Test3cx-xapi-pp-cli crm-integration update - Update CrmIntegration
crm-templates
Manage crm templates
3cx-xapi-pp-cli crm-templates - Invoke function GeCrmtTemplates
crm-templates-name
Manage crm templates name
3cx-xapi-pp-cli crm-templates-name delete-crm-template - Delete entity from CrmTemplates3cx-xapi-pp-cli crm-templates-name get-crm-template - Get entity from CrmTemplates by key
custom-prompts
Manage custom prompts
3cx-xapi-pp-cli custom-prompts list - Get entities from CustomPrompts3cx-xapi-pp-cli custom-prompts make-call-record - Invoke action MakeCallRecordCustomPrompt
custom-prompts-filename
Manage custom prompts filename
3cx-xapi-pp-cli custom-prompts-filename <Filename> - Delete entity from CustomPrompts
data-connector-settings
Manage data connector settings
3cx-xapi-pp-cli data-connector-settings get - Get DataConnectorSettings3cx-xapi-pp-cli data-connector-settings synchronize - Invoke action Synchronize3cx-xapi-pp-cli data-connector-settings test-data-connector - Invoke action TestDataConnector3cx-xapi-pp-cli data-connector-settings update - Update DataConnectorSettings
defs
Manage defs
3cx-xapi-pp-cli defs get - Get Defs3cx-xapi-pp-cli defs get-license-parameters - Invoke function GetLicenseParameters3cx-xapi-pp-cli defs get-routes - Invoke action GetRoutes3cx-xapi-pp-cli defs get-system-parameters - Invoke function GetSystemParameters3cx-xapi-pp-cli defs has-system-owner - Invoke function HasSystemOwner3cx-xapi-pp-cli defs list-codecs - Get Codecs from Defs3cx-xapi-pp-cli defs list-gateway-parameter-values - Get GatewayParameterValues from Defs3cx-xapi-pp-cli defs list-gateway-parameters - Get GatewayParameters from Defs3cx-xapi-pp-cli defs list-time-zones - Get TimeZones from Defs3cx-xapi-pp-cli defs send-email - Invoke action SendEmail
device-infos
Manage device infos
3cx-xapi-pp-cli device-infos - Get entities from DeviceInfos
device-infos-id
Manage device infos id
3cx-xapi-pp-cli device-infos-id delete-device-info - Delete entity from DeviceInfos3cx-xapi-pp-cli device-infos-id get-device-info - Get entity from DeviceInfos by key3cx-xapi-pp-cli device-infos-id provision - Invoke action Provision
dial-code-settings
Manage dial code settings
3cx-xapi-pp-cli dial-code-settings get - Get DialCodeSettings3cx-xapi-pp-cli dial-code-settings update - Update DialCodeSettings
did-numbers
Manage did numbers
3cx-xapi-pp-cli did-numbers - Get entities from DidNumbers
dnproperties
Manage dnproperties
3cx-xapi-pp-cli dnproperties create-dnproperty - Invoke action CreateDNProperty3cx-xapi-pp-cli dnproperties delete-dnproperty - Invoke action DeleteDNProperty3cx-xapi-pp-cli dnproperties get-dnproperty-by-name - Invoke function GetDNPropertyByName3cx-xapi-pp-cli dnproperties get-properties-by-dn - Invoke function GetPropertiesByDn3cx-xapi-pp-cli dnproperties update-dnproperty - Invoke action UpdateDNProperty
e164-settings
Manage e164 settings
3cx-xapi-pp-cli e164-settings get - Get E164Settings3cx-xapi-pp-cli e164-settings update - Update E164Settings
email-template
Manage email template
3cx-xapi-pp-cli email-template - Get entities from EmailTemplate
email-template-template-path
Manage email template template path
3cx-xapi-pp-cli email-template-template-path get-email-template - Get entity from EmailTemplate by key3cx-xapi-pp-cli email-template-template-path set-default - Invoke action SetDefault3cx-xapi-pp-cli email-template-template-path update-email-template - Update entity in EmailTemplate
emergency-geo-locations
Manage emergency geo locations
3cx-xapi-pp-cli emergency-geo-locations list - Get entities from EmergencyGeoLocations3cx-xapi-pp-cli emergency-geo-locations update - Invoke action Update
emergency-notifications-settings
Manage emergency notifications settings
3cx-xapi-pp-cli emergency-notifications-settings get - Get EmergencyNotificationsSettings3cx-xapi-pp-cli emergency-notifications-settings update - Update EmergencyNotificationsSettings
event-logs
Manage event logs
3cx-xapi-pp-cli event-logs download - Invoke function DownloadEventLogs3cx-xapi-pp-cli event-logs list - Get entities from EventLogs3cx-xapi-pp-cli event-logs purge - Invoke action PurgeEventLog
fax
Manage fax
3cx-xapi-pp-cli fax bulk-delete - Invoke action BulkFaxDelete3cx-xapi-pp-cli fax create - Add new entity to Fax3cx-xapi-pp-cli fax init - Invoke function InitFax3cx-xapi-pp-cli fax list - Get entities from Fax
fax-id
Manage fax id
3cx-xapi-pp-cli fax-id delete-fax - Delete entity from Fax3cx-xapi-pp-cli fax-id get-fax - Get entity from Fax by key3cx-xapi-pp-cli fax-id update-fax - Update entity in Fax
fax-number-number
Manage fax number number
3cx-xapi-pp-cli fax-number-number <Number> - Get entity from Fax by key (Number)
fax-server-settings
Manage fax server settings
3cx-xapi-pp-cli fax-server-settings clean-up-fax - Invoke action CleanUpFax3cx-xapi-pp-cli fax-server-settings get - Get FaxServerSettings3cx-xapi-pp-cli fax-server-settings get-fax-files-size - Invoke function GetFaxFilesSize3cx-xapi-pp-cli fax-server-settings update - Update FaxServerSettings
firewall
Manage firewall
3cx-xapi-pp-cli firewall get-last-result - Invoke function GetLastResult3cx-xapi-pp-cli firewall get-state - Get Firewall3cx-xapi-pp-cli firewall start-check - Invoke action StartCheck3cx-xapi-pp-cli firewall stop-check - Invoke action StopCheck
firmwares
Manage firmwares
3cx-xapi-pp-cli firmwares clean-up - Invoke action CleanUp3cx-xapi-pp-cli firmwares get-state - Invoke function GetFirmwareState3cx-xapi-pp-cli firmwares list - Get entities from Firmwares
firmwares-id
Manage firmwares id
3cx-xapi-pp-cli firmwares-id delete-firmware - Delete entity from Firmwares3cx-xapi-pp-cli firmwares-id push-firmware-for-phones - Invoke action PushFirmwareForPhones
fxs
Manage fxs
3cx-xapi-pp-cli fxs create - Add new entity to Fxs3cx-xapi-pp-cli fxs list - Get entities from Fxs
fxs-mac-address
Manage fxs mac address
3cx-xapi-pp-cli fxs-mac-address delete-fxs - Delete entity from Fxs3cx-xapi-pp-cli fxs-mac-address get-fxs - Get entity from Fxs by key3cx-xapi-pp-cli fxs-mac-address regenerate-web-credentials - Invoke action RegenerateWebCredentials3cx-xapi-pp-cli fxs-mac-address update-fxs - Update entity in Fxs
fxs-templates
Manage fxs templates
3cx-xapi-pp-cli fxs-templates create - Add new entity to FxsTemplates3cx-xapi-pp-cli fxs-templates list - Get entities from FxsTemplates
fxs-templates-id
Manage fxs templates id
3cx-xapi-pp-cli fxs-templates-id delete-fxs-template - Delete entity from FxsTemplates3cx-xapi-pp-cli fxs-templates-id get-fxs-template - Get entity from FxsTemplates by key3cx-xapi-pp-cli fxs-templates-id update-fxs-template - Update entity in FxsTemplates
general-settings-for-apps
Manage general settings for apps
3cx-xapi-pp-cli general-settings-for-apps get - Get GeneralSettingsForApps3cx-xapi-pp-cli general-settings-for-apps update - Update GeneralSettingsForApps
general-settings-for-pbx
Manage general settings for pbx
3cx-xapi-pp-cli general-settings-for-pbx get - Get GeneralSettingsForPbx3cx-xapi-pp-cli general-settings-for-pbx update - Update GeneralSettingsForPbx
get-client-crm-updates
Manage get client crm updates
3cx-xapi-pp-cli get-client-crm-updates - Invoke functionImport GetClientCrmUpdates
get-directory-info
Manage get directory info
3cx-xapi-pp-cli get-directory-info - Invoke actionImport GetDirectoryInfo
get-prompt-set-updates
Manage get prompt set updates
3cx-xapi-pp-cli get-prompt-set-updates - Invoke functionImport GetPromptSetUpdates
get-server-crm-updates
Manage get server crm updates
3cx-xapi-pp-cli get-server-crm-updates - Invoke functionImport GetServerCrmUpdates
get-update-settings
Manage get update settings
3cx-xapi-pp-cli get-update-settings - Invoke functionImport GetUpdateSettings
get-updates
Manage get updates
3cx-xapi-pp-cli get-updates - Invoke functionImport GetUpdates
get-updates-stats
Manage get updates stats
3cx-xapi-pp-cli get-updates-stats - Invoke functionImport GetUpdatesStats
google-settings
Manage google settings
3cx-xapi-pp-cli google-settings get - Get GoogleSettings3cx-xapi-pp-cli google-settings get-google-users - Invoke action GetGoogleUsers3cx-xapi-pp-cli google-settings update - Update GoogleSettings
groups
Manage groups
3cx-xapi-pp-cli groups create - Add new entity to Groups3cx-xapi-pp-cli groups delete-company-by-id - Invoke action DeleteCompanyById3cx-xapi-pp-cli groups delete-company-by-number - Invoke action DeleteCompanyByNumber3cx-xapi-pp-cli groups link-partner - Invoke action LinkGroupPartner3cx-xapi-pp-cli groups list - Get entities from Groups3cx-xapi-pp-cli groups replace-license-key - Invoke action ReplaceGroupLicenseKey3cx-xapi-pp-cli groups unlink-partner - Invoke action UnlinkGroupPartner
groups-id
Manage groups id
3cx-xapi-pp-cli groups-id delete-group - Delete entity from Groups3cx-xapi-pp-cli groups-id get-group - Get entity from Groups by key3cx-xapi-pp-cli groups-id get-restrictions - Invoke function GetRestrictions3cx-xapi-pp-cli groups-id list-members - Get Members from Groups3cx-xapi-pp-cli groups-id list-rights - Get Rights from Groups3cx-xapi-pp-cli groups-id update-group - Update entity in Groups
has-debian-upgrade
Manage has debian upgrade
3cx-xapi-pp-cli has-debian-upgrade - Invoke functionImport HasDebianUpgrade
holidays
Manage holidays
3cx-xapi-pp-cli holidays create - Add new entity to Holidays3cx-xapi-pp-cli holidays list - Get entities from Holidays
holidays-id
Manage holidays id
3cx-xapi-pp-cli holidays-id delete-holiday - Delete entity from Holidays3cx-xapi-pp-cli holidays-id get-holiday - Get entity from Holidays by key3cx-xapi-pp-cli holidays-id update-holiday - Update entity in Holidays
hotel-services
Manage hotel services
3cx-xapi-pp-cli hotel-services get - Get HotelServices3cx-xapi-pp-cli hotel-services update - Update HotelServices
inbound-rules
Manage inbound rules
3cx-xapi-pp-cli inbound-rules bulk-delete - Invoke action BulkInboundRulesDelete3cx-xapi-pp-cli inbound-rules create - Add new entity to InboundRules3cx-xapi-pp-cli inbound-rules export-caller-id-rules - Invoke function ExportCallerIdRules3cx-xapi-pp-cli inbound-rules list - Get entities from InboundRules
inbound-rules-id
Manage inbound rules id
3cx-xapi-pp-cli inbound-rules-id delete-inbound-rule - Delete entity from InboundRules3cx-xapi-pp-cli inbound-rules-id get-inbound-rule - Get entity from InboundRules by key3cx-xapi-pp-cli inbound-rules-id update-inbound-rule - Update entity in InboundRules
install-updates
Manage install updates
3cx-xapi-pp-cli install-updates - Invoke actionImport InstallUpdates
last-cdr-and-chat-message-timestamp
Manage last cdr and chat message timestamp
3cx-xapi-pp-cli last-cdr-and-chat-message-timestamp - Get entities from LastCdrAndChatMessageTimestamp
license-status
Manage license status
3cx-xapi-pp-cli license-status edit-license-info - Invoke action EditLicenseInfo3cx-xapi-pp-cli license-status get - Get LicenseStatus3cx-xapi-pp-cli license-status link-partner - Invoke action LinkPartner3cx-xapi-pp-cli license-status partner-info - Invoke function PartnerInfo3cx-xapi-pp-cli license-status refresh - Invoke action RefreshLicenseStatus3cx-xapi-pp-cli license-status replace-license-key - Invoke action ReplaceLicenseKey3cx-xapi-pp-cli license-status unlink-partner - Invoke action UnlinkPartner
logging-settings
Manage logging settings
3cx-xapi-pp-cli logging-settings get - Get LoggingSettings3cx-xapi-pp-cli logging-settings update - Update LoggingSettings
mail-settings
Manage mail settings
3cx-xapi-pp-cli mail-settings get - Get MailSettings3cx-xapi-pp-cli mail-settings test-email - Invoke action TestEmail3cx-xapi-pp-cli mail-settings update - Update MailSettings
microsoft365-integration
Manage microsoft365 integration
3cx-xapi-pp-cli microsoft365-integration authorize-presence - Invoke action AuthorizePresence3cx-xapi-pp-cli microsoft365-integration deauthorize-presence - Invoke action DeauthorizePresence3cx-xapi-pp-cli microsoft365-integration get - Get Microsoft365Integration3cx-xapi-pp-cli microsoft365-integration get-m365-groups - Invoke action GetM365Groups3cx-xapi-pp-cli microsoft365-integration get-m365-users - Invoke action GetM365Users3cx-xapi-pp-cli microsoft365-integration get-microsoft-access-token - Invoke function GetMicrosoftAccessToken3cx-xapi-pp-cli microsoft365-integration get-microsoft365-directory - Invoke function GetMicrosoft365Directory3cx-xapi-pp-cli microsoft365-integration get-users-by-principal-names - Invoke action GetUsersByPrincipalNames3cx-xapi-pp-cli microsoft365-integration test-presence - Invoke action TestPresence3cx-xapi-pp-cli microsoft365-integration test-subscription - Invoke function TestSubscription3cx-xapi-pp-cli microsoft365-integration update - Update Microsoft365Integration
microsoft365-teams-integration
Manage microsoft365 teams integration
3cx-xapi-pp-cli microsoft365-teams-integration check-fqdn-record - Invoke function CheckFqdnRecord3cx-xapi-pp-cli microsoft365-teams-integration check-map-users-script - Invoke function CheckMapUsersScript3cx-xapi-pp-cli microsoft365-teams-integration get - Get Microsoft365TeamsIntegration3cx-xapi-pp-cli microsoft365-teams-integration get-dial-plan-script - Invoke function GetDialPlanScript3cx-xapi-pp-cli microsoft365-teams-integration get-map-users-script - Invoke function GetMapUsersScript3cx-xapi-pp-cli microsoft365-teams-integration update - Update Microsoft365TeamsIntegration
music-on-hold-settings
Manage music on hold settings
3cx-xapi-pp-cli music-on-hold-settings get - Get MusicOnHoldSettings3cx-xapi-pp-cli music-on-hold-settings update - Update MusicOnHoldSettings
my-group
Manage my group
3cx-xapi-pp-cli my-group get - Get MyGroup3cx-xapi-pp-cli my-group get-partner-info - Invoke function GetMyGroupPartnerInfo3cx-xapi-pp-cli my-group get-restrictions - Invoke function GetRestrictions3cx-xapi-pp-cli my-group link-partner - Invoke action LinkMyGroupPartner3cx-xapi-pp-cli my-group list-members - Get Members from MyGroup3cx-xapi-pp-cli my-group list-rights - Get Rights from MyGroup3cx-xapi-pp-cli my-group replace-license-key - Invoke action ReplaceMyGroupLicenseKey3cx-xapi-pp-cli my-group unlink-partner - Invoke action UnlinkMyGroupPartner3cx-xapi-pp-cli my-group update - Update MyGroup
my-tokens
Manage my tokens
3cx-xapi-pp-cli my-tokens - Get entities from MyTokens
my-tokens-id
Manage my tokens id
3cx-xapi-pp-cli my-tokens-id <Id> - Invoke action RevokeToken
my-user
Manage my user
3cx-xapi-pp-cli my-user generate-prov-link - Invoke function GenerateProvLink3cx-xapi-pp-cli my-user get - Get MyUser3cx-xapi-pp-cli my-user list-forwarding-profiles - Get ForwardingProfiles from MyUser3cx-xapi-pp-cli my-user list-greetings - Get Greetings from MyUser3cx-xapi-pp-cli my-user list-groups - Get Groups from MyUser3cx-xapi-pp-cli my-user update - Update MyUser
network-interfaces
Manage network interfaces
3cx-xapi-pp-cli network-interfaces - Get entities from NetworkInterfaces
network-settings
Manage network settings
3cx-xapi-pp-cli network-settings get - Get NetworkSettings3cx-xapi-pp-cli network-settings get-ifaces - Invoke function GetIfaces3cx-xapi-pp-cli network-settings update - Update NetworkSettings
notification-settings
Manage notification settings
3cx-xapi-pp-cli notification-settings get - Get NotificationSettings3cx-xapi-pp-cli notification-settings update - Update NotificationSettings
office-hours
Manage office hours
3cx-xapi-pp-cli office-hours get - Get OfficeHours3cx-xapi-pp-cli office-hours update - Update OfficeHours
outbound-rules
Manage outbound rules
3cx-xapi-pp-cli outbound-rules create - Add new entity to OutboundRules3cx-xapi-pp-cli outbound-rules get-emergency - Invoke function GetEmergencyOutboundRules3cx-xapi-pp-cli outbound-rules list - Get entities from OutboundRules3cx-xapi-pp-cli outbound-rules move-up-down - Invoke action MoveUpDown3cx-xapi-pp-cli outbound-rules purge - Invoke action Purge
outbound-rules-id
Manage outbound rules id
3cx-xapi-pp-cli outbound-rules-id delete-outbound-rule - Delete entity from OutboundRules3cx-xapi-pp-cli outbound-rules-id get-outbound-rule - Get entity from OutboundRules by key3cx-xapi-pp-cli outbound-rules-id update-outbound-rule - Update entity in OutboundRules
parameters
Manage parameters
3cx-xapi-pp-cli parameters create - Add new entity to Parameters3cx-xapi-pp-cli parameters get-by-name - Invoke function GetParameterByName3cx-xapi-pp-cli parameters list - Get entities from Parameters
parameters-id
Manage parameters id
3cx-xapi-pp-cli parameters-id delete-parameter - Delete entity from Parameters3cx-xapi-pp-cli parameters-id get-parameter - Get entity from Parameters by key3cx-xapi-pp-cli parameters-id update-parameter - Update entity in Parameters
parkings
Manage parkings
3cx-xapi-pp-cli parkings create - Add new entity to Parkings3cx-xapi-pp-cli parkings list - Get entities from Parkings
parkings-id
Manage parkings id
3cx-xapi-pp-cli parkings-id delete-parking - Delete entity from Parkings3cx-xapi-pp-cli parkings-id get-parking - Get entity from Parkings by key3cx-xapi-pp-cli parkings-id list-parking-groups - Get Groups from Parkings3cx-xapi-pp-cli parkings-id update-parking - Update entity in Parkings
parkings-number-number
Manage parkings number number
3cx-xapi-pp-cli parkings-number-number <Number> - Get entity from Parkings by key (Number)
peers
Manage peers
3cx-xapi-pp-cli peers get-report - Invoke function GetReportPeers3cx-xapi-pp-cli peers list - Get entities from Peers3cx-xapi-pp-cli peers retreive-by-numbers - Invoke action RetreivePeersByNumbers
peers-number-number
Manage peers number number
3cx-xapi-pp-cli peers-number-number <Number> - Get entity from Peers by key (Number)
phone-book-settings
Manage phone book settings
3cx-xapi-pp-cli phone-book-settings get - Get PhoneBookSettings3cx-xapi-pp-cli phone-book-settings update - Update PhoneBookSettings
phone-logos
Manage phone logos
3cx-xapi-pp-cli phone-logos - Get entities from PhoneLogos
phone-logos-filename
Manage phone logos filename
3cx-xapi-pp-cli phone-logos-filename <Filename> - Delete entity from PhoneLogos
phone-templates
Manage phone templates
3cx-xapi-pp-cli phone-templates create - Add new entity to PhoneTemplates3cx-xapi-pp-cli phone-templates list - Get entities from PhoneTemplates
phone-templates-id
Manage phone templates id
3cx-xapi-pp-cli phone-templates-id delete-phone-template - Delete entity from PhoneTemplates3cx-xapi-pp-cli phone-templates-id get-phone-template - Get entity from PhoneTemplates by key3cx-xapi-pp-cli phone-templates-id update-phone-template - Update entity in PhoneTemplates
phones-settings
Manage phones settings
3cx-xapi-pp-cli phones-settings get - Get PhonesSettings3cx-xapi-pp-cli phones-settings update - Update PhonesSettings
playlists
Manage playlists
3cx-xapi-pp-cli playlists create - Add new entity to Playlists3cx-xapi-pp-cli playlists delete-file - Invoke action DeletePlaylistFile3cx-xapi-pp-cli playlists download-file - Invoke function DownloadPlaylistFile3cx-xapi-pp-cli playlists list - Get entities from Playlists
playlists-name
Manage playlists name
3cx-xapi-pp-cli playlists-name delete-playlist - Delete entity from Playlists3cx-xapi-pp-cli playlists-name get-playlist - Get entity from Playlists by key3cx-xapi-pp-cli playlists-name update-playlist - Update entity in Playlists
prompt-sets
Manage prompt sets
3cx-xapi-pp-cli prompt-sets get-active - Invoke function GetActive3cx-xapi-pp-cli prompt-sets list - Get entities from PromptSets
prompt-sets-id
Manage prompt sets id
3cx-xapi-pp-cli prompt-sets-id copy - Invoke action Copy3cx-xapi-pp-cli prompt-sets-id delete-prompt-set - Delete entity from PromptSets3cx-xapi-pp-cli prompt-sets-id get-prompt-set - Get entity from PromptSets by key3cx-xapi-pp-cli prompt-sets-id list-prompts - Get Prompts from PromptSets3cx-xapi-pp-cli prompt-sets-id play-prompt - Invoke action PlayPrompt3cx-xapi-pp-cli prompt-sets-id record-prompt - Invoke action RecordPrompt3cx-xapi-pp-cli prompt-sets-id set-active - Invoke action SetActive3cx-xapi-pp-cli prompt-sets-id set-alternate-pronunciation - Invoke action SetAlternatePronunciation3cx-xapi-pp-cli prompt-sets-id update-prompt-set - Update entity in PromptSets
purge-all-logs
Manage purge all logs
3cx-xapi-pp-cli purge-all-logs - Invoke actionImport PurgeAllLogs
purge-calls
Manage purge calls
3cx-xapi-pp-cli purge-calls - Invoke actionImport PurgeCalls
purge-chats
Manage purge chats
3cx-xapi-pp-cli purge-chats - Invoke actionImport PurgeChats
queues
Manage queues
3cx-xapi-pp-cli queues create - Add new entity to Queues3cx-xapi-pp-cli queues get-first-available-number - Invoke function GetFirstAvailableQueueNumber3cx-xapi-pp-cli queues list - Get entities from Queues
queues-id
Manage queues id
3cx-xapi-pp-cli queues-id delete-queue - Delete entity from Queues3cx-xapi-pp-cli queues-id get-queue - Get entity from Queues by key3cx-xapi-pp-cli queues-id list-agents - Get Agents from Queues3cx-xapi-pp-cli queues-id list-managers - Get Managers from Queues3cx-xapi-pp-cli queues-id reset-queue-statistics - Invoke action ResetQueueStatistics3cx-xapi-pp-cli queues-id update-queue - Update entity in Queues
queues-number-number
Manage queues number number
3cx-xapi-pp-cli queues-number-number <Number> - Get entity from Queues by key (Number)
receptionists
Manage receptionists
3cx-xapi-pp-cli receptionists create - Add new entity to Receptionists3cx-xapi-pp-cli receptionists get-first-available-number - Invoke function GetFirstAvailableReceptionistNumber3cx-xapi-pp-cli receptionists list - Get entities from Receptionists
receptionists-id
Manage receptionists id
3cx-xapi-pp-cli receptionists-id delete-receptionist - Delete entity from Receptionists3cx-xapi-pp-cli receptionists-id get-receptionist - Get entity from Receptionists by key3cx-xapi-pp-cli receptionists-id list-forwards - Get Forwards from Receptionists3cx-xapi-pp-cli receptionists-id update-receptionist - Update entity in Receptionists
receptionists-number-number
Manage receptionists number number
3cx-xapi-pp-cli receptionists-number-number <Number> - Get entity from Receptionists by key (Number)
recordings
Manage recordings
3cx-xapi-pp-cli recordings archive - Invoke action Archive3cx-xapi-pp-cli recordings bulk-archive - Invoke action BulkRecordingsArchive3cx-xapi-pp-cli recordings bulk-delete - Invoke action BulkRecordingsDelete3cx-xapi-pp-cli recordings download - Invoke function DownloadRecording3cx-xapi-pp-cli recordings get-repository-settings - Invoke function GetRecordingRepositorySettings3cx-xapi-pp-cli recordings list - Get entities from Recordings3cx-xapi-pp-cli recordings purge-archive - Invoke action PurgeArchive3cx-xapi-pp-cli recordings purge-local - Invoke action PurgeLocal3cx-xapi-pp-cli recordings set-repository-settings - Invoke action SetRecordingRepositorySettings3cx-xapi-pp-cli recordings transcribe - Invoke action TranscribeRecordings
remote-archiving-settings
Manage remote archiving settings
3cx-xapi-pp-cli remote-archiving-settings archive-chats - Invoke action ArchiveChats3cx-xapi-pp-cli remote-archiving-settings archive-faxes - Invoke action ArchiveFaxes3cx-xapi-pp-cli remote-archiving-settings archive-recordings - Invoke action ArchiveRecordings3cx-xapi-pp-cli remote-archiving-settings archive-voicemail - Invoke action ArchiveVoicemail3cx-xapi-pp-cli remote-archiving-settings get - Get RemoteArchivingSettings3cx-xapi-pp-cli remote-archiving-settings update - Update RemoteArchivingSettings
report-abandoned-chats-statistics
Manage report abandoned chats statistics
3cx-xapi-pp-cli report-abandoned-chats-statistics download-abandoned-chats-statistics - Invoke function DownloadAbandonedChatsStatistics3cx-xapi-pp-cli report-abandoned-chats-statistics get-abandoned-chats-statistics-data - Invoke function GetAbandonedChatsStatisticsData
report-abandoned-queue-calls
Manage report abandoned queue calls
3cx-xapi-pp-cli report-abandoned-queue-calls download-abandoned-queue-calls - Invoke function DownloadAbandonedQueueCalls3cx-xapi-pp-cli report-abandoned-queue-calls get-abandoned-queue-calls-data - Invoke function GetAbandonedQueueCallsData
report-agent-login-history
Manage report agent login history
3cx-xapi-pp-cli report-agent-login-history download-agent-login-history - Invoke function DownloadAgentLoginHistory3cx-xapi-pp-cli report-agent-login-history get-agent-login-history-data - Invoke function GetAgentLoginHistoryData
report-agents-in-queue-statistics
Manage report agents in queue statistics
3cx-xapi-pp-cli report-agents-in-queue-statistics download-agents-in-queue-statistics - Invoke function DownloadAgentsInQueueStatistics3cx-xapi-pp-cli report-agents-in-queue-statistics get-agents-in-queue-statistics-data - Invoke function GetAgentsInQueueStatisticsData
report-audit-log
Manage report audit log
3cx-xapi-pp-cli report-audit-log download-audit-log - Invoke function DownloadAuditLog3cx-xapi-pp-cli report-audit-log get-audit-log-data - Invoke function GetAuditLogData
report-average-queue-waiting-time
Manage report average queue waiting time
3cx-xapi-pp-cli report-average-queue-waiting-time download-average-queue-waiting-time-report - Invoke function DownloadAverageQueueWaitingTimeReport3cx-xapi-pp-cli report-average-queue-waiting-time get-average-queue-waiting-time-data - Invoke function GetAverageQueueWaitingTimeData
report-breaches-sla
Manage report breaches sla
3cx-xapi-pp-cli report-breaches-sla download-breaches-sla - Invoke function DownloadBreachesSla3cx-xapi-pp-cli report-breaches-sla get-breaches-sla-data - Invoke function GetBreachesSlaData
report-call-cost-by-extension-group
Manage report call cost by extension group
3cx-xapi-pp-cli report-call-cost-by-extension-group download-call-cost-by-extension-group - Invoke function DownloadCallCostByExtensionGroup3cx-xapi-pp-cli report-call-cost-by-extension-group get-call-cost-by-extension-group-data - Invoke function GetCallCostByExtensionGroupData
report-call-distribution
Manage report call distribution
3cx-xapi-pp-cli report-call-distribution download-get-get-call-distribution - Invoke function DownloadGetGetCallDistribution3cx-xapi-pp-cli report-call-distribution get-call-distribution - Invoke function GetCallDistribution
report-call-log-data
Manage report call log data
3cx-xapi-pp-cli report-call-log-data download-call-log - Invoke function DownloadCallLog3cx-xapi-pp-cli report-call-log-data get-call-log-data - Invoke function GetCallLogData3cx-xapi-pp-cli report-call-log-data get-call-quality-report - Invoke function GetCallQualityReport3cx-xapi-pp-cli report-call-log-data get-old-call-log-data - Invoke function GetOldCallLogData3cx-xapi-pp-cli report-call-log-data get-old-call-quality-report - Invoke function GetOldCallQualityReport
report-chat-log
Manage report chat log
3cx-xapi-pp-cli report-chat-log download-chat-log - Invoke function DownloadChatLog3cx-xapi-pp-cli report-chat-log get-chat-log - Invoke function GetChatLog
report-detailed-queue-statistics
Manage report detailed queue statistics
3cx-xapi-pp-cli report-detailed-queue-statistics download-detailed-queue-statistics - Invoke function DownloadDetailedQueueStatistics3cx-xapi-pp-cli report-detailed-queue-statistics get-detailed-queue-statistics-data - Invoke function GetDetailedQueueStatisticsData
report-extension-statistics
Manage report extension statistics
3cx-xapi-pp-cli report-extension-statistics download-extension-statistics - Invoke function DownloadExtensionStatistics3cx-xapi-pp-cli report-extension-statistics get-extension-statistics-data - Invoke function GetExtensionStatisticsData
report-extension-statistics-by-group
Manage report extension statistics by group
3cx-xapi-pp-cli report-extension-statistics-by-group download-extension-statistics-by-group - Invoke function DownloadExtensionStatisticsByGroup3cx-xapi-pp-cli report-extension-statistics-by-group get-extension-statistics-by-group-data - Invoke function GetExtensionStatisticsByGroupData
report-extensions-statistics-by-ring-groups
Manage report extensions statistics by ring groups
3cx-xapi-pp-cli report-extensions-statistics-by-ring-groups download-extensions-statistics-by-ring-groups - Invoke function DownloadExtensionsStatisticsByRingGroups3cx-xapi-pp-cli report-extensions-statistics-by-ring-groups get-extensions-statistics-by-ring-groups-data - Invoke function GetExtensionsStatisticsByRingGroupsData
report-inbound-calls
Manage report inbound calls
3cx-xapi-pp-cli report-inbound-calls download-get-inbound-calls - Invoke function DownloadGetInboundCalls3cx-xapi-pp-cli report-inbound-calls get-inbound-calls - Invoke function GetInboundCalls
report-inbound-rules
Manage report inbound rules
3cx-xapi-pp-cli report-inbound-rules download-inbound-rules - Invoke function DownloadInboundRules3cx-xapi-pp-cli report-inbound-rules get-inbound-rules-data - Invoke function GetInboundRulesData
report-outbound-calls
Manage report outbound calls
3cx-xapi-pp-cli report-outbound-calls download-get-outbound-calls - Invoke function DownloadGetOutboundCalls3cx-xapi-pp-cli report-outbound-calls get-outbound-calls - Invoke function GetOutboundCalls
report-queue-agents-chat-statistics
Manage report queue agents chat statistics
3cx-xapi-pp-cli report-queue-agents-chat-statistics download-queue-agents-chat-statistics - Invoke function DownloadQueueAgentsChatStatistics3cx-xapi-pp-cli report-queue-agents-chat-statistics get-queue-agents-chat-statistics-data - Invoke function GetQueueAgentsChatStatisticsData
report-queue-agents-chat-statistics-totals
Manage report queue agents chat statistics totals
3cx-xapi-pp-cli report-queue-agents-chat-statistics-totals download-queue-agents-chat-statistics-totals - Invoke function DownloadQueueAgentsChatStatisticsTotals3cx-xapi-pp-cli report-queue-agents-chat-statistics-totals get-queue-agents-chat-statistics-totals-data - Invoke function GetQueueAgentsChatStatisticsTotalsData
report-queue-an-un-calls
Manage report queue an un calls
3cx-xapi-pp-cli report-queue-an-un-calls download-queue-an-un-calls-report - Invoke function DownloadQueueAnUnCallsReport3cx-xapi-pp-cli report-queue-an-un-calls get-queue-an-un-calls-data - Invoke function GetQueueAnUnCallsData
report-queue-answered-calls-by-wait-time
Manage report queue answered calls by wait time
3cx-xapi-pp-cli report-queue-answered-calls-by-wait-time download-queue-answered-calls-by-wait-time - Invoke function DownloadQueueAnsweredCallsByWaitTime3cx-xapi-pp-cli report-queue-answered-calls-by-wait-time get-queue-answered-calls-by-wait-time-data - Invoke function GetQueueAnsweredCallsByWaitTimeData
report-queue-callbacks
Manage report queue callbacks
3cx-xapi-pp-cli report-queue-callbacks download-queue-callbacks - Invoke function DownloadQueueCallbacks3cx-xapi-pp-cli report-queue-callbacks get-queue-callbacks-data - Invoke function GetQueueCallbacksData
report-queue-chat-performance
Manage report queue chat performance
3cx-xapi-pp-cli report-queue-chat-performance download-queue-chat-performance - Invoke function DownloadQueueChatPerformance3cx-xapi-pp-cli report-queue-chat-performance get-queue-chat-performance-data - Invoke function GetQueueChatPerformanceData
report-queue-failed-callbacks
Manage report queue failed callbacks
3cx-xapi-pp-cli report-queue-failed-callbacks download-queue-failed-callbacks - Invoke function DownloadQueueFailedCallbacks3cx-xapi-pp-cli report-queue-failed-callbacks get-queue-failed-callbacks-data - Invoke function GetQueueFailedCallbacksData
report-queue-performance-overview
Manage report queue performance overview
3cx-xapi-pp-cli report-queue-performance-overview download-queue-performance-overview - Invoke function DownloadQueuePerformanceOverview3cx-xapi-pp-cli report-queue-performance-overview get-queue-performance-overview-data - Invoke function GetQueuePerformanceOverviewData
report-queue-performance-totals
Manage report queue performance totals
3cx-xapi-pp-cli report-queue-performance-totals download-queue-performance-totals - Invoke function DownloadQueuePerformanceTotals3cx-xapi-pp-cli report-queue-performance-totals get-queue-performance-totals-data - Invoke function GetQueuePerformanceTotalsData
report-ring-group-statistics
Manage report ring group statistics
3cx-xapi-pp-cli report-ring-group-statistics download-ring-group-statistics - Invoke function DownloadRingGroupStatistics3cx-xapi-pp-cli report-ring-group-statistics get-ring-group-statistics-data - Invoke function GetRingGroupStatisticsData
report-statistic-sla
Manage report statistic sla
3cx-xapi-pp-cli report-statistic-sla download-statistic-sla - Invoke function DownloadStatisticSla3cx-xapi-pp-cli report-statistic-sla get-statistic-sla-data - Invoke function GetStatisticSlaData
report-team-queue-general-statistics
Manage report team queue general statistics
3cx-xapi-pp-cli report-team-queue-general-statistics download-team-queue-general-statistics - Invoke function DownloadTeamQueueGeneralStatistics3cx-xapi-pp-cli report-team-queue-general-statistics get-team-queue-general-statistics-data - Invoke function GetTeamQueueGeneralStatisticsData
report-user-activity
Manage report user activity
3cx-xapi-pp-cli report-user-activity download-get-user-activity - Invoke function DownloadGetUserActivity3cx-xapi-pp-cli report-user-activity get-user-activity - Invoke function GetUserActivity
ring-groups
Manage ring groups
3cx-xapi-pp-cli ring-groups create - Add new entity to RingGroups3cx-xapi-pp-cli ring-groups get-first-available-number - Invoke function GetFirstAvailableRingGroupNumber3cx-xapi-pp-cli ring-groups list - Get entities from RingGroups
ring-groups-id
Manage ring groups id
3cx-xapi-pp-cli ring-groups-id delete-ring-group - Delete entity from RingGroups3cx-xapi-pp-cli ring-groups-id get-ring-group - Get entity from RingGroups by key3cx-xapi-pp-cli ring-groups-id list-ring-group-members - Get Members from RingGroups3cx-xapi-pp-cli ring-groups-id update-ring-group - Update entity in RingGroups
ring-groups-number-number
Manage ring groups number number
3cx-xapi-pp-cli ring-groups-number-number <Number> - Get entity from RingGroups by key (Number)
sbcs
Manage sbcs
3cx-xapi-pp-cli sbcs create - Add new entity to Sbcs3cx-xapi-pp-cli sbcs list - Get entities from Sbcs
sbcs-name
Manage sbcs name
3cx-xapi-pp-cli sbcs-name delete-sbc - Delete entity from Sbcs3cx-xapi-pp-cli sbcs-name get-sbc - Get entity from Sbcs by key3cx-xapi-pp-cli sbcs-name push-config - Invoke action PushConfig3cx-xapi-pp-cli sbcs-name update-sbc - Update entity in Sbcs
scheduled-reports
Manage scheduled reports
3cx-xapi-pp-cli scheduled-reports create - Add new entity to ScheduledReports3cx-xapi-pp-cli scheduled-reports list - Get entities from ScheduledReports
scheduled-reports-id
Manage scheduled reports id
3cx-xapi-pp-cli scheduled-reports-id delete-scheduled-report - Delete entity from ScheduledReports3cx-xapi-pp-cli scheduled-reports-id get-scheduled-report - Get entity from ScheduledReports by key3cx-xapi-pp-cli scheduled-reports-id update-scheduled-report - Update entity in ScheduledReports
secure-sip-settings
Manage secure sip settings
3cx-xapi-pp-cli secure-sip-settings get - Get SecureSipSettings3cx-xapi-pp-cli secure-sip-settings update - Update SecureSipSettings
security-tokens
Manage security tokens
3cx-xapi-pp-cli security-tokens - Get entities from SecurityTokens
security-tokens-id
Manage security tokens id
3cx-xapi-pp-cli security-tokens-id <Id> - Invoke action RevokeToken
service-principals
Manage service principals
3cx-xapi-pp-cli service-principals create - Add new entity to ServicePrincipals3cx-xapi-pp-cli service-principals list - Get entities from ServicePrincipals
service-principals-id
Manage service principals id
3cx-xapi-pp-cli service-principals-id delete-service-principal - Delete entity from ServicePrincipals3cx-xapi-pp-cli service-principals-id generate-app-token - Invoke action GenerateAppToken3cx-xapi-pp-cli service-principals-id get-service-principal - Get entity from ServicePrincipals by key3cx-xapi-pp-cli service-principals-id update-service-principal - Update entity in ServicePrincipals
services
Manage services
3cx-xapi-pp-cli services disable - Invoke action Disable3cx-xapi-pp-cli services enable - Invoke action Enable3cx-xapi-pp-cli services garbage-collect - Invoke action GarbageCollect3cx-xapi-pp-cli services list-info - Get entities from Services3cx-xapi-pp-cli services restart - Invoke action Restart3cx-xapi-pp-cli services restart-operating-system - Invoke action RestartOperatingSystem3cx-xapi-pp-cli services start - Invoke action Start3cx-xapi-pp-cli services stop - Invoke action Stop
set-update-settings
Manage set update settings
3cx-xapi-pp-cli set-update-settings - Invoke actionImport SetUpdateSettings
sip-devices
Manage sip devices
3cx-xapi-pp-cli sip-devices - Get entities from SipDevices
sip-devices-id
Manage sip devices id
3cx-xapi-pp-cli sip-devices-id <Id> - Invoke action PushFirmware
syslog-settings
Manage syslog settings
3cx-xapi-pp-cli syslog-settings get - Get SyslogSettings3cx-xapi-pp-cli syslog-settings test-connection - Invoke action TestConnection3cx-xapi-pp-cli syslog-settings update - Update SyslogSettings
system-status
Manage system status
3cx-xapi-pp-cli system-status apitoken - Invoke function APIToken3cx-xapi-pp-cli system-status get - Get SystemStatus3cx-xapi-pp-cli system-status get-remote-access-status - Invoke function GetRemoteAccessStatus3cx-xapi-pp-cli system-status get-request-help-link - Invoke function GetRequestHelpLink3cx-xapi-pp-cli system-status get-version-type - Invoke function GetVersionType3cx-xapi-pp-cli system-status is-request-help-enabled - Invoke function IsRequestHelpEnabled3cx-xapi-pp-cli system-status my-phone-request-id-telemetry - Invoke function MyPhoneRequestIdTelemetry3cx-xapi-pp-cli system-status network-telemetry - Invoke function NetworkTelemetry3cx-xapi-pp-cli system-status request-help - Invoke action RequestHelp3cx-xapi-pp-cli system-status revoke-remote-access - Invoke action RevokeRemoteAccess3cx-xapi-pp-cli system-status service-telemetry - Invoke function ServiceTelemetry3cx-xapi-pp-cli system-status set-chat-log-status - Invoke action SetChatLogStatus3cx-xapi-pp-cli system-status set-multi-company-mode - Invoke action SetMultiCompanyMode3cx-xapi-pp-cli system-status start-dbmaintenance - Invoke action StartDBMaintenance3cx-xapi-pp-cli system-status system-database-information - Invoke function SystemDatabaseInformation3cx-xapi-pp-cli system-status system-extensions - Invoke function SystemExtensions3cx-xapi-pp-cli system-status system-health-status - Invoke function SystemHealthStatus3cx-xapi-pp-cli system-status system-telemetry - Invoke function SystemTelemetry
tenant-properties
Manage tenant properties
3cx-xapi-pp-cli tenant-properties create-property - Add new entity to TenantProperties3cx-xapi-pp-cli tenant-properties list-property - Get entities from TenantProperties
tenant-properties-name
Manage tenant properties name
3cx-xapi-pp-cli tenant-properties-name delete-property - Delete entity from TenantProperties3cx-xapi-pp-cli tenant-properties-name get-property - Get entity from TenantProperties by key3cx-xapi-pp-cli tenant-properties-name update-property - Update entity in TenantProperties
trunk-templates
Manage trunk templates
3cx-xapi-pp-cli trunk-templates create - Add new entity to TrunkTemplates3cx-xapi-pp-cli trunk-templates list - Get entities from TrunkTemplates
trunk-templates-id
Manage trunk templates id
3cx-xapi-pp-cli trunk-templates-id delete-trunk-template - Delete entity from TrunkTemplates3cx-xapi-pp-cli trunk-templates-id get-trunk-template - Get entity from TrunkTemplates by key3cx-xapi-pp-cli trunk-templates-id update-trunk-template - Update entity in TrunkTemplates
trunks
Manage trunks
3cx-xapi-pp-cli trunks create - Add new entity to Trunks3cx-xapi-pp-cli trunks finalize-provisioning - Invoke action FinalizeTrunkProvisioning3cx-xapi-pp-cli trunks get-first-available-number - Invoke function GetFirstAvailableTrunkNumber3cx-xapi-pp-cli trunks get-provider-phones - Invoke action GetProviderPhones3cx-xapi-pp-cli trunks init - Invoke function InitTrunk3cx-xapi-pp-cli trunks init-master-bridge - Invoke function InitMasterBridge3cx-xapi-pp-cli trunks init-slave-bridge - Invoke function InitSlaveBridge3cx-xapi-pp-cli trunks list - Get entities from Trunks3cx-xapi-pp-cli trunks refresh-registration - Invoke action RefreshRegistration3cx-xapi-pp-cli trunks set-routes - Invoke action SetRoutes
trunks-id
Manage trunks id
3cx-xapi-pp-cli trunks-id delete-trunk - Delete entity from Trunks3cx-xapi-pp-cli trunks-id export-trunk - Invoke function ExportTrunk3cx-xapi-pp-cli trunks-id get-trunk - Get entity from Trunks by key3cx-xapi-pp-cli trunks-id run-analysis - Invoke action RunAnalysis3cx-xapi-pp-cli trunks-id test-inbound-call - Invoke action TestInboundCall3cx-xapi-pp-cli trunks-id test-outbound-call - Invoke action TestOutboundCall3cx-xapi-pp-cli trunks-id update-trunk - Update entity in Trunks
trunks-number-number
Manage trunks number number
3cx-xapi-pp-cli trunks-number-number <Number> - Get entity from Trunks by key (Number)
upgrade-debian
Manage upgrade debian
3cx-xapi-pp-cli upgrade-debian - Invoke actionImport UpgradeDebian
users
Manage users
3cx-xapi-pp-cli users batch-delete - Invoke action BatchDelete3cx-xapi-pp-cli users bulk-update - Invoke action BulkUpdate3cx-xapi-pp-cli users create - Add new entity to Users3cx-xapi-pp-cli users download-greeting - Invoke function DownloadGreeting3cx-xapi-pp-cli users export-extensions - Invoke function ExportExtensions3cx-xapi-pp-cli users get-duplicated-emails - Invoke action GetDuplicatedEmails3cx-xapi-pp-cli users get-first-available-extension-number - Invoke function GetFirstAvailableExtensionNumber3cx-xapi-pp-cli users get-first-available-hotdesking-number - Invoke function GetFirstAvailableHotdeskingNumber3cx-xapi-pp-cli users get-multi-edit-greetings - Invoke action GetMultiEditGreetings3cx-xapi-pp-cli users get-phone-registrar - Invoke function GetPhoneRegistrar3cx-xapi-pp-cli users get-phone-registrars - Invoke action GetPhoneRegistrars3cx-xapi-pp-cli users install-firmware - Invoke action InstallFirmware3cx-xapi-pp-cli users list - Get entities from Users3cx-xapi-pp-cli users make-call - Invoke action MakeCall3cx-xapi-pp-cli users multi-delete-greeting - Invoke action MultiDeleteGreeting3cx-xapi-pp-cli users multi-update - Invoke action MultiUserUpdate3cx-xapi-pp-cli users reboot-phone - Invoke action RebootPhone3cx-xapi-pp-cli users regenerate-passwords - Invoke action RegeneratePasswords3cx-xapi-pp-cli users reprovision-all-phones - Invoke action ReprovisionAllPhones3cx-xapi-pp-cli users reprovision-phone - Invoke action ReprovisionPhone3cx-xapi-pp-cli users upgrade-phone - Invoke action UpgradePhone
users-id
Manage users id
3cx-xapi-pp-cli users-id delete-user - Delete entity from Users3cx-xapi-pp-cli users-id generate-prov-link - Invoke function GenerateProvLink3cx-xapi-pp-cli users-id get-phone-secret - Invoke function GetPhoneSecret3cx-xapi-pp-cli users-id get-user - Get entity from Users by key3cx-xapi-pp-cli users-id has-duplicated-email - Invoke function HasDuplicatedEmail3cx-xapi-pp-cli users-id list-forwarding-profiles - Get ForwardingProfiles from Users3cx-xapi-pp-cli users-id list-greetings - Get Greetings from Users3cx-xapi-pp-cli users-id list-groups - Get Groups from Users3cx-xapi-pp-cli users-id make-call-user-record-greeting - Invoke action MakeCallUserRecordGreeting3cx-xapi-pp-cli users-id regenerate - Invoke action Regenerate3cx-xapi-pp-cli users-id send-welcome-email - Invoke action SendWelcomeEmail3cx-xapi-pp-cli users-id set-monitor-status - Invoke action SetMonitorStatus3cx-xapi-pp-cli users-id update-user - Update entity in Users
users-number-number
Manage users number number
3cx-xapi-pp-cli users-number-number <Number> - Get entity from Users by key (Number)
voicemail-settings
Manage voicemail settings
3cx-xapi-pp-cli voicemail-settings create-converter-configuration - Invoke action CreateConverterConfiguration3cx-xapi-pp-cli voicemail-settings delete-all-user-voicemails - Invoke action DeleteAllUserVoicemails3cx-xapi-pp-cli voicemail-settings delete-converter-configuration - Invoke action DeleteConverterConfiguration3cx-xapi-pp-cli voicemail-settings get - Get VoicemailSettings3cx-xapi-pp-cli voicemail-settings get-configured-converters - Invoke function GetConfiguredConverters3cx-xapi-pp-cli voicemail-settings get-connected-converters-data - Invoke function GetConnectedConvertersData3cx-xapi-pp-cli voicemail-settings get-converter-request-status - Invoke function GetConverterRequestStatus3cx-xapi-pp-cli voicemail-settings get-transcribe-languages - Invoke function GetTranscribeLanguages3cx-xapi-pp-cli voicemail-settings update - Update VoicemailSettings
website-links
Manage website links
3cx-xapi-pp-cli website-links bulk-links-delete - Invoke action BulkLinksDelete3cx-xapi-pp-cli website-links create-weblink - Add new entity to WebsiteLinks3cx-xapi-pp-cli website-links list-weblink - Get entities from WebsiteLinks3cx-xapi-pp-cli website-links validate-link - Invoke action ValidateLink
website-links-link
Manage website links link
3cx-xapi-pp-cli website-links-link delete-weblink - Delete entity from WebsiteLinks3cx-xapi-pp-cli website-links-link get-weblink - Get entity from WebsiteLinks by key3cx-xapi-pp-cli website-links-link update-weblink - Update entity in WebsiteLinks
Output Formats
# Human-readable table (default in terminal, JSON when piped)
3cx-xapi-pp-cli active-calls
# JSON for scripting and agents
3cx-xapi-pp-cli active-calls --json
# Filter to specific fields
3cx-xapi-pp-cli active-calls --json --select id,name,status
# Dry run — show the request without sending
3cx-xapi-pp-cli active-calls --dry-run
# Agent mode — JSON + compact + no prompts in one flag
3cx-xapi-pp-cli active-calls --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Explicit retries - add
--idempotent to create retries and add --ignore-missing to delete retries when a no-op success is acceptable
- Confirmable -
--yes for explicit confirmation of destructive actions
- Piped input - write commands can accept structured input when their help lists
--stdin
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Runtime Endpoint
This CLI resolves endpoint placeholders at runtime, so one installed binary can target different tenants or API versions without regeneration.
Endpoint environment variables:
3CX_XAPI_AFTER resolves {after}3CX_XAPI_ID resolves {id}3CX_XAPI_LIMIT resolves {limit}
Base URL: set TCX_FQDN (e.g. your-company.3cx.com.au); the CLI derives https://<fqdn>/xapi/v1 and the /connect/token endpoint
Health Check
3cx-xapi-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Run 3cx-xapi-pp-cli doctor to see the resolved config, data, state, and cache directories. The platform-default config path is ~/.config/xapi-pp-cli/config.toml; --home, API_3CX_XAPI_HOME, and per-kind env vars can relocate it.
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|
API_3CX_XAPI_AFTER | endpoint | Yes | |
API_3CX_XAPI_ID | endpoint | Yes | |
API_3CX_XAPI_LIMIT | endpoint | Yes | |
TCX_CLIENT_ID | per_call | Yes | Set to your API credential. |
TCX_CLIENT_SECRET | per_call | Yes | Set to your API credential. |
agentcookie (optional)
If you use agentcookie to sync secrets across machines, this CLI auto-adopts agentcookie-managed credentials with no extra setup. When the daemon writes to this CLI's config, 3cx-xapi-pp-cli doctor reports agentcookie: detected and auth-status labels the source as agentcookie. Skip this section if you don't use agentcookie - the CLI works the same as any other.
Troubleshooting
Authentication errors (exit code 4)
- Run
3cx-xapi-pp-cli doctor to check credentials
- Verify the environment variable is set:
echo $TCX_CLIENT_ID
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
API-specific
- 403 Forbidden on call history or reports — The API client Service Principal needs the System Owner role, not System Administrator. Re-assign it under Admin > Integrations > API.
- 401 Unauthorized on every command — Check TCX_CLIENT_ID and TCX_CLIENT_SECRET and that the API client has the 3CX Configuration API checkbox enabled. Run: 3cx-xapi-pp-cli doctor
- Connection or DNS error — Set TCX_FQDN (or the base-url config) to your instance, for example https://your-company.3cx.com.au; the CLI appends /xapi/v1 and /connect/token automatically.
- search, audit, or trace return nothing — Populate the local mirror first: 3cx-xapi-pp-cli sync --resources users,groups,ring-groups,queues,trunks,inbound-rules,did-numbers
Known Gaps
Verified live against a production 3CX V20 instance: every documented command — including the novel features (audit, trace, qrollup, search, diff, posture, provision) and all resource list/sync paths — works. The following peripheral, generated endpoints have known limitations (tracked for a future release):
- File-download / export endpoints (
users export-extensions, event-logs download, call-history-view download-call-history, inbound-rules export-caller-id-rules, report-inbound-rules download-inbound-rules, call-cost-settings export-call-costs, microsoft365-teams-integration get-dial-plan-script, and similar) return CSV/script files rather than JSON. The current command expects JSON and reports an error instead of emitting the file body. Use the 3CX web console for these exports until a future release adds raw-body output.
- Mode-gated status endpoints (
system-status apitoken, conference-settings get-mcurequest-status, microsoft365-teams-integration get-map-users-script, voicemail-settings get-converter-request-status) return HTTP 400 unless the PBX is in the specific mode they require (e.g. MCM mode). This is the API's own precondition, surfaced as an actionable error.
- Very large responses (
recordings list, report-audit-log get-audit-log-data, system-status service-telemetry, system-status system-telemetry) return correctly but can be large; narrow them with --top/--select for agent use.
Sources & Inspiration
This CLI was built by studying these projects and resources:
Generated by CLI Printing Press