Connect 3CX

Written By Christopher Scaminaci

Last updated About 3 hours ago

3CX is a phone system that a customer runs on their own server, in their own cloud, or as an instance hosted by 3CX. Every customer has their own PBX with its own address, so one StackJack connection reaches one PBX. StackJack talks to the two APIs 3CX publishes for it, the Configuration API (everything you can do in the Admin Console) and the Call Control API (live calls), through one connection.

Connecting a 3CX PBX to StackJack gives your AI assistant a family of tcx_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

Check the health of the PBX - system status, services and which one is down, the licence and when it expires, update status, the firewall checker, event logs, the activity log and the network settings
Answer questions about calls - the call log for any period, call quality for one call, inbound and outbound volume, the audit log, and the queue, SLA, abandoned-call, agent-login and extension reports
Look up who and what is on the PBX - users and extensions, departments, contacts, phones and the firmware they run, and who has which number
Read the call path - inbound and outbound rules, DID numbers, digital receptionists, ring groups, queues, office hours, holidays, parking and call flow apps
Read trunks and gateways - SIP trunks and their registration, SBCs, FXS gateways and trunk templates
Read security and access - the IP and caller block lists, the anti-hacking settings, API clients and tokens
Download files - call-history and report exports, recordings, greetings and playlists, and the generated dial-plan and script files, each as a short-lived download link
Onboard and change people (on Pro plans) - create and update users, send the welcome email, regenerate passwords, and reboot or reprovision a phone
Change the call path (on Pro plans) - edit rules, receptionists, queues, ring groups, office hours and holidays, and add or change trunks, SBCs and gateways
Run the PBX (on Pro plans) - start a backup, restart a service, install updates, manage departments on a multi-company PBX, and change general, mail, logging and integration settings
Work with live calls (on Pro plans) - see the calls in progress, drop one, place a call from an extension, and answer, divert, route or transfer a call on a monitored extension

What you need before you start

The 3CX AI edition (8SC or higher). The Configuration API is not part of the lower editions. A PBX on Free Basic, Basic or Pro does not offer it, and StackJack cannot connect to it.

A PBX that StackJack can reach from the internet. StackJack calls your PBX over HTTPS from outside your network. That works when the PBX is published at a public address with a certificate from a publicly trusted authority, which is how an instance hosted by 3CX and most PBXs that serve the remote apps already run. It does not work for a PBX reachable only on your own network, and it does not work with a self-signed certificate. The PBX's HTTPS port is usually 443 or 5001; enter whichever one you use.

Access from StackJack's addresses, if you restrict the console. If you limit the Admin Console to an address list, StackJack's calls have to be allowed through it. We give those addresses by support ticket rather than publishing them.

How StackJack authenticates to 3CX

3CX has no vendor portal and no partner-level credential. Every PBX issues its own API client, so you do this once per PBX you want StackJack to reach.

Sign in to the 3CX Admin Console as a System Owner or System Admin.
Go to Integrations > API and add a client for StackJack.
Tick 3CX Configuration API Access. To use the live call control tools, also tick 3CX Call Control API Access.
Choose a department and a role. System Owner or System Admin gives StackJack the whole PBX. Any other role limits StackJack to what that role may do.
Copy the Client ID and the API key before you close the dialog. 3CX shows the key only once; if you lose it, generate a new one.
In StackJack, enter the PBX address, the Client ID and the API key.

StackJack exchanges the pair for an access token that lasts one hour, keeps it cached, and renews it by itself, so there is no renewal step. The pair keeps working until someone changes or deletes the client on the PBX.

Give StackJack its own API client

The PBX keeps only one access token active at a time. If another tool uses the same API client, each one's sign-in invalidates the other's token and both start failing at busy moments. Create a separate client for StackJack and do not share it.

Two things to get right before you save

Use an HTTPS address. The API key travels in the sign-in request and the access token travels in every call. A plain http:// address would expose both, so StackJack refuses it.

Check the pair before you save it. A PBX can ban an address that fails to sign in repeatedly. StackJack disables a failing connection after three failed checks and, after a refusal, waits a short while before it tries the PBX again, which keeps a typo from getting StackJack's address banned. If you fix something on the PBX after a refusal, allow a few minutes before testing again.

Live call control

The live call control tools use the Call Control API, which needs a second permission and a second setting. Tick 3CX Call Control API Access on the API client, and make sure the extensions you want to control are ones that client monitors. Without both, those tools answer that the action is not allowed, while every Configuration API tool keeps working.

Permissions

3CX has no permission scopes on this API. What the client can do is decided by its role and department on the PBX, and a client with the System Owner or System Admin role reaches everything.

That makes StackJack a second place where least privilege happens, so it is worth being deliberate:

Reads are Free. Everything that only answers a question is available on the Free plan.
Every change is Pro. Creating, editing, deleting and anything that touches a live call or the running PBX.
The tools you allow are the boundary. An assistant that only needs to answer questions about calls should be granted read tools and nothing else.

Tools that change live phone service

Some of these tools do things a customer will notice immediately. StackJack marks each of them as a change tool, and it is worth knowing which they are before you grant them. Whether your AI application stops to ask you first depends on that application's own settings - see Destructive tools and confirmation. Review those settings, and restrict the tools you grant, before you allow changes:

Live calls - dropping a call in progress, and answering, diverting, routing or transferring one
Calls that ring a phone - placing a call from an extension, testing a trunk with an inbound or outbound call, and playing or recording a prompt or greeting over the phone
Messages to people - the welcome email and the test and notification emails reach real mailboxes, and a help request reaches 3CX support
Desk phones - rebooting, reprovisioning, moving or pushing firmware to phones people are using
Running services - stopping, restarting or disabling a service, restarting the operating system, installing updates, and starting database maintenance
Restore and licence - restoring a backup over the running PBX, replacing a licence key and linking or unlinking a reseller
Who can call in and out - trunks, outbound rules, emergency settings, the block lists and the anti-hacking settings. A wrong value silently drops legitimate calls or lets unwanted ones through
Locking yourself out - the console access restrictions and the network settings. A wrong value can make the PBX unreachable
Credentials - regenerating user passwords, creating a user or changing a user's roles and passwords, generating a phone provisioning link (it lets a phone or app configure itself without a password), revoking tokens and API keys, and creating or changing an API client
Jobs that run on their own later - saving settings that can arm automatic deletion or archiving of recordings, voicemail, chats, faxes and logs, a scheduled restore or update, scheduled firmware updates for the desk phones, the data offload, the user sync with Microsoft 365 or Google, and reports that 3CX emails to people on a schedule
Stored passwords and keys - saving the mail, backup, syslog, Teams, Amazon, AI, CRM, directory search and conference settings stores a password, key or PIN that the PBX keeps and uses. So does creating or changing a trunk, an SBC, an FXS gateway or a fax extension, and creating a trunk from a provider's phone numbers, because their records carry the SIP or gateway password
Deletions and purges - every delete, and every purge of calls, chats, logs, recordings or backups, which the PBX cannot undo

Reads that can return passwords

3CX stores SIP passwords and other secrets in several records, and the matching reads return them as part of the record. These are the user, extension, trunk, phone, SBC and FXS reads, the extension and trunk exports, and the settings reads for backups, archiving, mail, logging, voicemail transcription, directory search, and the Google, Microsoft Teams, Amazon, data connector and AI integrations. Two more reads return a credential outright: the PBX's API token and the Microsoft access token the PBX holds.

StackJack does not strip those fields, so an agent that reads a user sees what 3CX returns. StackJack never records such a result for evaluation, never stores an oversized one as a file, and the extension and trunk exports always answer inline rather than as a download link. Anything an agent reads can still appear in its conversation, so grant these tools only to agents that need them, and ask for only the fields you need.

Downloads and exports

Call-history and report exports, recordings, greetings, playlists and the generated script files are files rather than data. StackJack saves the file and returns a short-lived, read-only download link with its type, size and exact expiry, so it never has to carry a recording through the conversation. If the link cannot be created, the tool says so rather than handing back a dead one.

Where the numbers come from

Every page-size limit here is StackJack's, not 3CX's. 3CX documents no maximum, and a call log or event log on a busy PBX can be very large, so StackJack always asks for a page: 50 records by default and at most 100. Ask for the next page with a skip, and ask for the total with a count. Report tools take their period and filters as required values, so name a date range rather than asking for everything. A file export is the exception: it is the whole result unless you give it a row limit.

3CX documents no request limit. StackJack keeps its own courtesy cap on how fast one connection calls a PBX, because the target is often a small server and an agent loop must not load it.

Several customers, and multi-company PBXs

Every customer has their own PBX. Add one connection per customer from the connector's card, name it after the customer, and your AI names it on each call. Omit the name and the call runs against your default connection. Pin an endpoint to one connection when an AI should never reach past a single customer. See Several connections of one connector.

A multi-company PBX hosts several small customers on one instance as departments. One connection with the System Owner or System Admin role reaches every department, and the department tools take a department id or a filter to narrow a request to one customer. The API needs the AI edition even where multi-company mode itself does not, so a multi-company PBX can be connected only when it runs the AI edition.

If something goes wrong

The connection test is refused. Check the edition first: a PBX below the AI edition does not offer the API. Then check the address is the one you reach the 3CX web client at, that its certificate is publicly trusted, and that the Admin Console's access restrictions allow StackJack through. Then check the Client ID and API key match the client on the PBX.

Calls work, then fail for a while, then work. Another tool is probably using the same API client, so the PBX keeps swapping which one holds the token. Create a separate client for StackJack.

A tool says the action is not allowed. The client's role or department does not cover it, or the API access box is not ticked. Open the client under Integrations > API and check both. For live call control, check the second box and the monitored extensions.

A tool says the route or record was not found. Either the record does not exist, or the PBX build is older than the route. StackJack follows the newest 3CX version 20 build, and a route added in a later update answers not found on an earlier one. Update the PBX under Updates in the Admin Console. If every tool answers not found, the address is wrong.

Something answered, but it was not 3CX. A sign-in page, a firewall or a reverse proxy replied instead of the PBX. Enter the exact address you reach the 3CX web client at, including the port when it is not 443.

Full tool reference

Every tcx_ tool, with its plan and whether it reads or changes something: 3CX tools.

3CX tools

tcx_ · 610 tools · Free 334 · Pro 276

System status

Tool	What it does
`tcx_api_token` Free · Read-only	Read the PBX API token.
`tcx_get_remote_access_status` Free · Read-only	Get the remote support access status.
`tcx_get_request_help_link` Pro · Destructive	DESTRUCTIVE: Request a remote support access link.
`tcx_get_system_status` Free · Read-only	Get the PBX system status.
`tcx_get_version_type` Free · Read-only	Get the PBX version type.
`tcx_is_request_help_enabled` Free · Read-only	Check whether the PBX can request 3CX support.
`tcx_my_phone_request_id_telemetry` Free · Read-only	Get MyPhone request telemetry for a date range.
`tcx_network_telemetry` Free · Read-only	Get PBX network traffic telemetry.
`tcx_request_help` Pro · Destructive	DESTRUCTIVE: Send a help request to 3CX support.
`tcx_revoke_remote_access` Pro · Destructive	DESTRUCTIVE: Revoke remote support access.
`tcx_service_telemetry` Free · Read-only	Get PBX service resource telemetry.
`tcx_set_chat_log_status` Pro · Write	Turn PBX chat logging on or off.
`tcx_set_multi_company_mode` Pro · Destructive	DESTRUCTIVE: Turn multi-company mode on or off.
`tcx_start_db_maintenance` Pro · Destructive	DESTRUCTIVE: Start PBX database maintenance.
`tcx_system_database_information` Free · Read-only	Get PBX database space usage.
`tcx_system_extensions` Free · Read-only	List the PBX system extensions.
`tcx_system_health_status` Free · Read-only	Get the PBX health summary.
`tcx_system_telemetry` Free · Read-only	Get PBX CPU, memory and disk telemetry.

Services

Tool	What it does
`tcx_disable` Pro · Destructive	DESTRUCTIVE: Disable PBX services.
`tcx_enable` Pro · Write	Enable PBX services.
`tcx_garbage_collect` Pro · Destructive	DESTRUCTIVE: Run a garbage collection in the PBX.
`tcx_list_service_info` Free · Read-only	List PBX services and their status.
`tcx_restart` Pro · Destructive	DESTRUCTIVE: Restart PBX services.
`tcx_restart_operating_system` Pro · Destructive	DESTRUCTIVE: Restart the PBX operating system.
`tcx_start` Pro · Write	Start PBX services.
`tcx_stop` Pro · Destructive	DESTRUCTIVE: Stop PBX services.

Updates

Tool	What it does
`tcx_get_prompt_set_updates` Free · Read-only	List available prompt set updates.
`tcx_get_server_crm_updates` Free · Read-only	List available CRM integration updates.
`tcx_get_update_details` Free · Read-only	Get the details of one update.
`tcx_get_update_settings` Free · Read-only	Get the PBX update settings.
`tcx_get_updates` Free · Read-only	List available PBX updates.
`tcx_get_updates_stats` Free · Read-only	Get available update counts by category.
`tcx_install_updates` Pro · Destructive	DESTRUCTIVE: Install PBX updates.
`tcx_set_update_settings` Pro · Destructive	DESTRUCTIVE: Change the PBX update settings.

License

Tool	What it does
`tcx_edit_license_info` Pro · Destructive	DESTRUCTIVE: Edit the license contact details.
`tcx_get_license_status` Free · Read-only	Get the PBX license status.
`tcx_link_partner` Pro · Destructive	DESTRUCTIVE: Link a reseller partner to the PBX license.
`tcx_partner_info` Free · Read-only	Look up a reseller partner by id.
`tcx_refresh_license_status` Pro · Write	Refresh the PBX license status.
`tcx_replace_license_key` Pro · Destructive	DESTRUCTIVE: Replace the PBX license key.
`tcx_unlink_partner` Pro · Destructive	DESTRUCTIVE: Unlink the reseller partner from the PBX.

System definitions

Tool	What it does
`tcx_get_defs` Free · Read-only	Get the PBX definitions.
`tcx_get_license_parameters` Free · Read-only	Get the PBX license capabilities.
`tcx_get_routes` Free · Read-only	Get the DID routes for a list of ids.
`tcx_get_system_parameters` Free · Read-only	Get the PBX system parameters.
`tcx_has_system_owner` Free · Read-only	Check whether the PBX has a system owner.
`tcx_list_codecs` Free · Read-only	List the PBX audio codecs.
`tcx_list_gateway_parameter_values` Free · Read-only	List the gateway parameter values.
`tcx_list_gateway_parameters` Free · Read-only	List the gateway parameters.
`tcx_list_time_zones` Free · Read-only	List the time zones the PBX supports.
`tcx_report_log_event` Pro · Write	Write an entry to the PBX event log.
`tcx_send_email` Pro · Destructive	DESTRUCTIVE: Send a templated email from the PBX.

Firewall checker

Tool	What it does
`tcx_get_firewall_state` Free · Read-only	Get the firewall checker state.
`tcx_get_last_result` Free · Read-only	Get the last firewall check result.
`tcx_start_check` Pro · Write	Start the firewall check.
`tcx_stop_check` Pro · Write	Stop the firewall check.

Network

Tool	What it does
`tcx_get_ifaces` Free · Read-only	List the PBX network interface names.
`tcx_get_network_settings` Free · Read-only	Get the PBX network settings.
`tcx_list_network_interface` Free · Read-only	List the PBX network interfaces.
`tcx_update_network_settings` Pro · Destructive	DESTRUCTIVE: Change the PBX network settings.

Logs

Tool	What it does
`tcx_download_event_logs` Free · Read-only	Download the PBX event log as a file.
`tcx_get_filter` Free · Read-only	Get the activity log filter values.
`tcx_get_logs` Free · Read-only	Get activity log lines for a date range.
`tcx_list_event_log` Free · Read-only	List PBX event log entries.
`tcx_purge_event_log` Pro · Destructive	DESTRUCTIVE: Purge the PBX event log.
`tcx_purge_logs` Pro · Destructive	DESTRUCTIVE: Purge the PBX activity log.

Reference data

Tool	What it does
`tcx_create_parameter` Pro · Write	Create a PBX parameter.
`tcx_delete_parameter` Pro · Destructive	DESTRUCTIVE: Delete a PBX parameter.
`tcx_get_country_codes` Free · Read-only	Get the PBX country code list.
`tcx_get_parameter` Free · Read-only	Get a PBX parameter by id.
`tcx_get_parameter_by_name` Free · Read-only	Get a PBX parameter by name.
`tcx_list_country` Free · Read-only	List the PBX country definitions.
`tcx_list_last_cdr_and_chat_message_timestamp` Free · Read-only	Get the time of the last call and chat records.
`tcx_list_parameter` Free · Read-only	List PBX parameters.
`tcx_update_country_codes` Pro · Destructive	DESTRUCTIVE: Replace the PBX country code list.
`tcx_update_parameter` Pro · Write	Update a PBX parameter.

Backups

Tool	What it does
`tcx_backup` Pro · Write	Start a backup of the PBX.
`tcx_delete_backups` Pro · Destructive	DESTRUCTIVE: Delete a PBX backup file.
`tcx_get_backup_extras` Free · Read-only	Get the details of a backup file.
`tcx_get_backup_failover_settings` Free · Read-only	Get the backup failover settings.
`tcx_get_backup_repository_settings` Free · Read-only	Get the backup storage location settings.
`tcx_get_backup_settings` Free · Read-only	Get the scheduled backup settings.
`tcx_get_can_create_backup` Free · Read-only	Check whether a backup can be created.
`tcx_get_failover_scripts` Free · Read-only	List the failover script files.
`tcx_get_local_backup_size` Free · Read-only	Get the total size of the local backups.
`tcx_get_restore_settings` Free · Read-only	Get the scheduled restore settings.
`tcx_get_sftp_host_key` Free · Read-only	Get an SFTP server's host key.
`tcx_list_backups` Free · Read-only	List the PBX backup files.
`tcx_purge_local_backups` Pro · Destructive	DESTRUCTIVE: Purge all local backups.
`tcx_restore` Pro · Destructive	DESTRUCTIVE: Restore a backup over the running PBX.
`tcx_set_backup_failover_settings` Pro · Write	Change the backup failover settings.
`tcx_set_backup_repository_settings` Pro · Destructive	DESTRUCTIVE: Change the backup storage location.
`tcx_set_backup_settings` Pro · Destructive	DESTRUCTIVE: Change the scheduled backup settings.
`tcx_set_restore_settings` Pro · Destructive	DESTRUCTIVE: Change the scheduled restore settings.

IP block list

Tool	What it does
`tcx_bulk_ips_delete` Pro · Destructive	DESTRUCTIVE: Delete several IP block list entries.
`tcx_create_blocklist_addr` Pro · Write	Add an entry to the IP block list.
`tcx_delete_blocklist_addr` Pro · Destructive	DESTRUCTIVE: Delete an IP block list entry.
`tcx_get_blocklist_addr` Free · Read-only	Get an IP block list entry.
`tcx_list_blocklist_addr` Free · Read-only	List IP block list entries.
`tcx_update_blocklist_addr` Pro · Write	Update an IP block list entry.

Caller block list

Tool	What it does
`tcx_bulk_numbers_delete` Pro · Destructive	DESTRUCTIVE: Delete several caller block list numbers.
`tcx_create_black_list_number` Pro · Write	Add a number to the caller block list.
`tcx_delete_black_list_number` Pro · Destructive	DESTRUCTIVE: Delete a caller block list number.
`tcx_get_black_list_number` Free · Read-only	Get a caller block list number.
`tcx_list_black_list_number` Free · Read-only	List caller block list numbers.
`tcx_update_black_list_number` Pro · Write	Update a caller block list number.

Access restrictions

Tool	What it does
`tcx_get_anti_hacking_settings` Free · Read-only	Get the anti-hacking settings.
`tcx_get_console_restrictions` Free · Read-only	Get the admin console access restrictions.
`tcx_update_anti_hacking_settings` Pro · Destructive	DESTRUCTIVE: Change the anti-hacking settings.
`tcx_update_console_restrictions` Pro · Destructive	DESTRUCTIVE: Change the admin console access restrictions.

Security tokens

Tool	What it does
`tcx_list_refresh_token` Free · Read-only	List this API client's refresh tokens.
`tcx_list_security_refresh_token` Free · Read-only	List the PBX security refresh tokens.
`tcx_revoke_security_token` Pro · Destructive	DESTRUCTIVE: Revoke a security refresh token.
`tcx_revoke_token` Pro · Destructive	DESTRUCTIVE: Revoke one of this API client's refresh tokens.

API clients

Tool	What it does
`tcx_create_service_principal` Pro · Destructive	DESTRUCTIVE: Create an API client (service principal).
`tcx_delete_o_auth_client` Pro · Destructive	DESTRUCTIVE: Delete an OAuth client.
`tcx_delete_service_principal` Pro · Destructive	DESTRUCTIVE: Delete an API client (service principal).
`tcx_get_o_auth_client` Free · Read-only	Get an OAuth client.
`tcx_get_service_principal` Free · Read-only	Get an API client (service principal).
`tcx_list_o_auth_client` Free · Read-only	List OAuth clients.
`tcx_list_service_principal` Free · Read-only	List API clients (service principals).
`tcx_refresh_client_metadata` Pro · Write	Refresh an OAuth client's metadata.
`tcx_update_service_principal` Pro · Destructive	DESTRUCTIVE: Update an API client (service principal).

Users

Tool	What it does
`tcx_batch_delete` Pro · Destructive	DESTRUCTIVE: Delete several users at once.
`tcx_bulk_update` Pro · Destructive	DESTRUCTIVE: Apply one user record to several users.
`tcx_create_user` Pro · Destructive	DESTRUCTIVE: Create a user (extension).
`tcx_delete_user` Pro · Destructive	DESTRUCTIVE: Delete a user.
`tcx_download_greeting` Free · Read-only	Download a user's greeting file.
`tcx_export_extensions` Free · Read-only	Export extensions inline.
`tcx_generate_prov_link` Pro · Destructive	DESTRUCTIVE: Generate a user's phone provisioning link.
`tcx_get_duplicated_emails` Free · Read-only	Check email addresses for duplicates.
`tcx_get_first_available_extension_number` Free · Read-only	Get first available extension number.
`tcx_get_first_available_hotdesking_number` Free · Read-only	Get first available hotdesking number.
`tcx_get_multi_edit_greetings` Free · Read-only	Get the greetings of several users.
`tcx_get_phone_registrar` Free · Read-only	Get a phone's registration by MAC address.
`tcx_get_phone_registrars` Free · Read-only	Get phone registrations for several MAC addresses.
`tcx_get_user` Free · Read-only	Get a user by Id.
`tcx_get_user_by_number` Free · Read-only	Get a user by extension number.
`tcx_has_duplicated_email` Free · Read-only	Check whether a user's email is duplicated.
`tcx_install_firmware` Pro · Destructive	DESTRUCTIVE: Install firmware on phones by model.
`tcx_list_forwarding_profiles` Free · Read-only	List a user's forwarding profiles.
`tcx_list_greetings` Free · Read-only	List a user's greetings.
`tcx_list_groups` Free · Read-only	List a user's department memberships.
`tcx_list_user` Free · Read-only	List users.
`tcx_make_call` Pro · Destructive	DESTRUCTIVE: Place a call from an extension.
`tcx_make_call_user_record_greeting` Pro · Destructive	DESTRUCTIVE: Call an extension to record a greeting.
`tcx_multi_delete_greeting` Pro · Destructive	DESTRUCTIVE: Delete a greeting from several users.
`tcx_multi_user_update` Pro · Destructive	DESTRUCTIVE: Edit several users with the multi-edit fields.
`tcx_reboot_phone` Pro · Destructive	DESTRUCTIVE: Reboot a phone by MAC address.
`tcx_regenerate` Pro · Destructive	DESTRUCTIVE: Regenerate a user's credentials.
`tcx_regenerate_passwords` Pro · Destructive	DESTRUCTIVE: Regenerate credentials for several users.
`tcx_reprovision_all_phones` Pro · Destructive	DESTRUCTIVE: Reprovision all phones of several users.
`tcx_reprovision_phone` Pro · Destructive	DESTRUCTIVE: Reprovision a phone by MAC address.
`tcx_resend_rps` Pro · Write	Resend a phone's RPS registration.
`tcx_revoke_rps` Pro · Destructive	DESTRUCTIVE: Revoke a phone's RPS registration.
`tcx_send_welcome_email` Pro · Destructive	DESTRUCTIVE: Send a user the welcome email.
`tcx_set_monitor_status` Pro · Write	Set a user's monitor status.
`tcx_update_user` Pro · Destructive	DESTRUCTIVE: Update a user.

My user

Tool	What it does
`tcx_get_my_user` Free · Read-only	Get my user.
`tcx_list_my_user_forwarding_profiles` Free · Read-only	List my user's forwarding profiles.
`tcx_list_my_user_greetings` Free · Read-only	List my user's greetings.
`tcx_list_my_user_groups` Free · Read-only	List my user's department memberships.
`tcx_my_user_generate_prov_link` Pro · Destructive	DESTRUCTIVE: Generate my user's phone provisioning link.
`tcx_update_my_user` Pro · Destructive	DESTRUCTIVE: Update my user.

Extension properties

Tool	What it does
`tcx_create_dn_property` Pro · Write	Create an extension property.
`tcx_delete_dn_property` Pro · Destructive	DESTRUCTIVE: Delete an extension property.
`tcx_get_dn_property_by_name` Free · Read-only	Get an extension property by name.
`tcx_get_properties_by_dn` Free · Read-only	List an extension's properties.
`tcx_update_dn_property` Pro · Write	Update an extension property.

Peers and directories

Tool	What it does
`tcx_get_directory_info` Free · Read-only	Browse folders on a storage location.
`tcx_get_peer_by_number` Free · Read-only	Get a peer by number.
`tcx_get_report_peers` Free · Read-only	List the peers available to reports.
`tcx_list_peer` Free · Read-only	List peers.
`tcx_retreive_peers_by_numbers` Free · Read-only	Get peers for a list of numbers.

Departments

Tool	What it does
`tcx_create_group` Pro · Write	Create a department.
`tcx_delete_company_by_id` Pro · Destructive	DESTRUCTIVE: Delete a department by Id.
`tcx_delete_company_by_number` Pro · Destructive	DESTRUCTIVE: Delete a department by number.
`tcx_delete_group` Pro · Destructive	DESTRUCTIVE: Delete a department (OData delete).
`tcx_get_group` Free · Read-only	Get a department by Id.
`tcx_get_restrictions` Free · Read-only	Get a department's usage limits.
`tcx_link_group_partner` Pro · Destructive	DESTRUCTIVE: Link a reseller partner to a department.
`tcx_list_group` Free · Read-only	List departments.
`tcx_list_members` Free · Read-only	List a department's members.
`tcx_list_rights` Free · Read-only	List a department's roles and rights.
`tcx_replace_group_license_key` Pro · Destructive	DESTRUCTIVE: Replace a department's license key.
`tcx_unlink_group_partner` Pro · Destructive	DESTRUCTIVE: Unlink the reseller partner from a department.
`tcx_update_group` Pro · Write	Update a department.

My department

Tool	What it does
`tcx_get_my_group` Free · Read-only	Get my department.
`tcx_get_my_group_partner_info` Free · Read-only	Get reseller details for my department.
`tcx_get_my_group_restrictions` Free · Read-only	Get my department's usage limits.
`tcx_link_my_group_partner` Pro · Destructive	DESTRUCTIVE: Link a reseller partner to my department.
`tcx_list_my_group_members` Free · Read-only	List my department's members.
`tcx_list_my_group_rights` Free · Read-only	List my department's roles and rights.
`tcx_replace_my_group_license_key` Pro · Destructive	DESTRUCTIVE: Replace my department's license key.
`tcx_unlink_my_group_partner` Pro · Destructive	DESTRUCTIVE: Unlink the reseller partner from my department.
`tcx_update_my_group` Pro · Write	Update my department.

Tenant properties

Tool	What it does
`tcx_create_property` Pro · Write	Create a tenant property.
`tcx_delete_property` Pro · Destructive	DESTRUCTIVE: Delete a tenant property.
`tcx_get_property` Free · Read-only	Get a tenant property by name.
`tcx_list_property` Free · Read-only	List tenant properties.
`tcx_update_property` Pro · Write	Update a tenant property.

Contacts

Tool	What it does
`tcx_create_contact` Pro · Write	Create a contact.
`tcx_create_contact_by_number` Pro · Write	Create a contact for a number.
`tcx_delete_contact` Pro · Destructive	DESTRUCTIVE: Delete a contact.
`tcx_delete_contacts_by_id` Pro · Destructive	DESTRUCTIVE: Delete several contacts by Id.
`tcx_delete_contacts_by_type` Pro · Destructive	DESTRUCTIVE: Delete all contacts of a source.
`tcx_delete_department_contacts_by_type` Pro · Destructive	DESTRUCTIVE: Delete all department contacts of a source.
`tcx_delete_personal_contacts_by_type` Pro · Destructive	DESTRUCTIVE: Delete all personal contacts of a source.
`tcx_get_contact` Free · Read-only	Get a contact by Id.
`tcx_get_contacts_by_number` Free · Read-only	Find contacts by phone number.
`tcx_get_dir_search_settings` Free · Read-only	Get the Exchange directory search settings.
`tcx_list_contact` Free · Read-only	List contacts.
`tcx_set_dir_search_settings` Pro · Destructive	DESTRUCTIVE: Set the Exchange directory search settings.
`tcx_update_contact` Pro · Write	Update a contact.

Phonebook settings

Tool	What it does
`tcx_get_phone_book_settings` Free · Read-only	Get the phone book settings.
`tcx_update_phone_book_settings` Pro · Write	Update the phone book settings.

Inbound rules

Tool	What it does
`tcx_bulk_inbound_rules_delete` Pro · Destructive	DESTRUCTIVE: Delete several inbound rules at once.
`tcx_create_inbound_rule` Pro · Write	Create an inbound rule.
`tcx_delete_inbound_rule` Pro · Destructive	DESTRUCTIVE: Delete an inbound rule.
`tcx_export_caller_id_rules` Free · Read-only	Export the caller ID rules as a file.
`tcx_get_inbound_rule` Free · Read-only	Get an inbound rule.
`tcx_list_inbound_rule` Free · Read-only	List inbound rules.
`tcx_update_inbound_rule` Pro · Write	Update an inbound rule.

Outbound rules

Tool	What it does
`tcx_create_outbound_rule` Pro · Write	Create an outbound rule.
`tcx_delete_outbound_rule` Pro · Destructive	DESTRUCTIVE: Delete an outbound rule.
`tcx_get_emergency_outbound_rules` Free · Read-only	List the emergency outbound rules.
`tcx_get_outbound_rule` Free · Read-only	Get an outbound rule.
`tcx_list_outbound_rule` Free · Read-only	List outbound rules.
`tcx_move_up_down` Pro · Write	Move an outbound rule up or down in the rule list.
`tcx_purge` Pro · Destructive	DESTRUCTIVE: Purge outbound rules by id.
`tcx_update_outbound_rule` Pro · Write	Update an outbound rule.

DID numbers

Tool	What it does
`tcx_list_did_number` Free · Read-only	List DID numbers.

Digital receptionists

Tool	What it does
`tcx_create_receptionist` Pro · Write	Create a digital receptionist.
`tcx_delete_receptionist` Pro · Destructive	DESTRUCTIVE: Delete a digital receptionist.
`tcx_get_first_available_receptionist_number` Free · Read-only	Get the next free receptionist number.
`tcx_get_receptionist` Free · Read-only	Get a digital receptionist by id.
`tcx_get_receptionist_by_number` Free · Read-only	Get a digital receptionist by number.
`tcx_list_forwards` Free · Read-only	List a digital receptionist's menu options.
`tcx_list_receptionist` Free · Read-only	List digital receptionists.
`tcx_update_receptionist` Pro · Write	Update a digital receptionist.

Ring groups

Tool	What it does
`tcx_create_ring_group` Pro · Write	Create a ring group.
`tcx_delete_ring_group` Pro · Destructive	DESTRUCTIVE: Delete a ring group.
`tcx_get_first_available_ring_group_number` Free · Read-only	Get the next free ring group number.
`tcx_get_ring_group` Free · Read-only	Get a ring group by id.
`tcx_get_ring_group_by_number` Free · Read-only	Get a ring group by number.
`tcx_list_ring_group` Free · Read-only	List ring groups.
`tcx_list_ring_group_members` Free · Read-only	List a ring group's members.
`tcx_update_ring_group` Pro · Write	Update a ring group.

Queues

Tool	What it does
`tcx_create_queue` Pro · Write	Create a call queue.
`tcx_delete_queue` Pro · Destructive	DESTRUCTIVE: Delete a call queue.
`tcx_get_first_available_queue_number` Free · Read-only	Get the next free queue number.
`tcx_get_queue` Free · Read-only	Get a call queue by id.
`tcx_get_queue_by_number` Free · Read-only	Get a call queue by number.
`tcx_list_agents` Free · Read-only	List a call queue's agents.
`tcx_list_managers` Free · Read-only	List a call queue's managers.
`tcx_list_queue` Free · Read-only	List call queues.
`tcx_reset_queue_statistics` Pro · Destructive	DESTRUCTIVE: Reset a call queue's statistics.
`tcx_update_queue` Pro · Write	Update a call queue.

Office hours and holidays

Tool	What it does
`tcx_create_holiday` Pro · Write	Create a holiday.
`tcx_delete_holiday` Pro · Destructive	DESTRUCTIVE: Delete a holiday.
`tcx_get_holiday` Free · Read-only	Get a holiday.
`tcx_get_office_hours` Free · Read-only	Get the PBX office hours.
`tcx_list_holiday` Free · Read-only	List holidays.
`tcx_update_holiday` Pro · Write	Update a holiday.
`tcx_update_office_hours` Pro · Write	Update the PBX office hours.

Parking

Tool	What it does
`tcx_create_parking` Pro · Write	Create a shared parking extension.
`tcx_delete_parking` Pro · Destructive	DESTRUCTIVE: Delete a shared parking extension.
`tcx_get_parking` Free · Read-only	Get a shared parking extension by id.
`tcx_get_parking_by_number` Free · Read-only	Get a shared parking extension by number.
`tcx_list_parking` Free · Read-only	List shared parking extensions.
`tcx_list_parking_groups` Free · Read-only	List the departments of a shared parking extension.
`tcx_update_parking` Pro · Write	Update a shared parking extension.

Call flow apps

Tool	What it does
`tcx_create_call_flow_app` Pro · Destructive	DESTRUCTIVE: Create a call flow app.
`tcx_delete_call_flow_app` Pro · Destructive	DESTRUCTIVE: Delete a call flow app.
`tcx_delete_file` Pro · Destructive	DESTRUCTIVE: Delete a file from a call flow app.
`tcx_get_call_flow_app` Free · Read-only	Get a call flow app.
`tcx_get_files` Free · Read-only	List the files of a call flow app.
`tcx_list_call_flow_app` Free · Read-only	List call flow apps.
`tcx_list_call_flow_script` Free · Read-only	List the call flow scripts.
`tcx_update_call_flow_app` Pro · Destructive	DESTRUCTIVE: Update a call flow app.

Dialing settings

Tool	What it does
`tcx_get_call_parking_settings` Free · Read-only	Get the call parking settings.
`tcx_get_call_types_settings` Free · Read-only	Get the call types settings.
`tcx_get_dial_code_settings` Free · Read-only	Get the feature dial codes.
`tcx_get_e164_settings` Free · Read-only	Get the E.164 number settings.
`tcx_list_emergency_geo_location` Free · Read-only	List the emergency geo-locations.
`tcx_update` Pro · Destructive	DESTRUCTIVE: Replace the emergency geo-locations.
`tcx_update_call_parking_settings` Pro · Write	Update the call parking settings.
`tcx_update_call_types_settings` Pro · Write	Update the call types settings.
`tcx_update_dial_code_settings` Pro · Write	Update the feature dial codes.
`tcx_update_e164_settings` Pro · Write	Update the E.164 number settings.

Live calls

Tool	What it does
`tcx_drop_call` Pro · Destructive	DESTRUCTIVE: Hang up a live call.
`tcx_list_active_call` Free · Read-only	List calls in progress.

Prompts

Tool	What it does
`tcx_copy` Pro · Write	Copy a prompt set.
`tcx_delete_custom_prompt` Pro · Destructive	DESTRUCTIVE: Delete a custom prompt.
`tcx_delete_prompt_set` Pro · Destructive	DESTRUCTIVE: Delete a prompt set.
`tcx_get_active` Free · Read-only	Get the active prompt set.
`tcx_get_prompt_set` Free · Read-only	Get a prompt set.
`tcx_list_custom_prompt` Free · Read-only	List custom prompts.
`tcx_list_prompt_set` Free · Read-only	List prompt sets.
`tcx_list_prompts` Free · Read-only	List the prompts in a prompt set.
`tcx_make_call_record_custom_prompt` Pro · Destructive	DESTRUCTIVE: Ring an extension to record a custom prompt.
`tcx_play_prompt` Pro · Destructive	DESTRUCTIVE: Play a prompt to an extension.
`tcx_record_prompt` Pro · Destructive	DESTRUCTIVE: Record a prompt through an extension.
`tcx_set_active` Pro · Write	Make a prompt set the active one.
`tcx_set_alternate_pronunciation` Pro · Write	Turn alternate number pronunciation on or off for a prompt set.
`tcx_update_prompt_set` Pro · Write	Update a prompt set.

Playlists and music on hold

Tool	What it does
`tcx_create_playlist` Pro · Write	Create a playlist.
`tcx_delete_playlist` Pro · Destructive	DESTRUCTIVE: Delete a playlist.
`tcx_delete_playlist_file` Pro · Destructive	DESTRUCTIVE: Delete a file from a playlist.
`tcx_download_playlist_file` Free · Read-only	Download a playlist audio file.
`tcx_get_music_on_hold_settings` Free · Read-only	Get the music on hold settings.
`tcx_get_playlist` Free · Read-only	Get a playlist.
`tcx_list_playlist` Free · Read-only	List playlists.
`tcx_update_music_on_hold_settings` Pro · Write	Update the music on hold settings.
`tcx_update_playlist` Pro · Write	Update a playlist.

Trunks

Tool	What it does
`tcx_create_trunk` Pro · Destructive	DESTRUCTIVE: Create a trunk.
`tcx_delete_trunk` Pro · Destructive	DESTRUCTIVE: Delete a trunk.
`tcx_export_trunk` Free · Read-only	Export a trunk inline.
`tcx_finalize_trunk_provisioning` Pro · Destructive	DESTRUCTIVE: Create a trunk from provider phone numbers.
`tcx_get_first_available_trunk_number` Free · Read-only	Get the first free trunk number.
`tcx_get_provider_phones` Free · Read-only	List the phone numbers of a provider account.
`tcx_get_trunk` Free · Read-only	Get a trunk by Id.
`tcx_get_trunk_by_number` Free · Read-only	Get a trunk by its number.
`tcx_init_master_bridge` Free · Read-only	Get a new master bridge trunk record.
`tcx_init_slave_bridge` Free · Read-only	Get a new slave bridge trunk record.
`tcx_init_trunk` Free · Read-only	Get a new trunk record for a template.
`tcx_list_trunk` Free · Read-only	List trunks and bridges.
`tcx_refresh_registration` Pro · Write	Refresh a trunk's SIP registration.
`tcx_run_analysis` Pro · Write	Run the trunk analysis.
`tcx_set_routes` Pro · Destructive	DESTRUCTIVE: Set DID routes for trunks.
`tcx_test_inbound_call` Pro · Destructive	DESTRUCTIVE: Run an inbound call test on a trunk.
`tcx_test_outbound_call` Pro · Destructive	DESTRUCTIVE: Place a test outbound call through a trunk.
`tcx_update_trunk` Pro · Destructive	DESTRUCTIVE: Update a trunk.

Trunk templates

Tool	What it does
`tcx_create_trunk_template` Pro · Write	Create a custom trunk template.
`tcx_delete_trunk_template` Pro · Destructive	DESTRUCTIVE: Delete a trunk template.
`tcx_get_trunk_template` Free · Read-only	Get a trunk template by Id.
`tcx_list_trunk_template` Free · Read-only	List trunk templates.
`tcx_update_trunk_template` Pro · Write	Update a trunk template.

SBCs

Tool	What it does
`tcx_create_sbc` Pro · Destructive	DESTRUCTIVE: Create an SBC.
`tcx_delete_sbc` Pro · Destructive	DESTRUCTIVE: Delete an SBC.
`tcx_get_sbc` Free · Read-only	Get an SBC by name.
`tcx_list_sbc` Free · Read-only	List SBCs.
`tcx_push_config` Pro · Destructive	DESTRUCTIVE: Push the configuration to an SBC.
`tcx_update_sbc` Pro · Destructive	DESTRUCTIVE: Update an SBC.

FXS gateways

Tool	What it does
`tcx_create_fxs` Pro · Destructive	DESTRUCTIVE: Create an FXS gateway.
`tcx_create_fxs_template` Pro · Write	Create an FXS device template.
`tcx_delete_fxs` Pro · Destructive	DESTRUCTIVE: Delete an FXS gateway.
`tcx_delete_fxs_template` Pro · Destructive	DESTRUCTIVE: Delete an FXS device template.
`tcx_get_fxs` Free · Read-only	Get an FXS gateway by MAC address.
`tcx_get_fxs_template` Free · Read-only	Get an FXS device template by Id.
`tcx_list_fxs` Free · Read-only	List FXS gateways.
`tcx_list_fxs_template` Free · Read-only	List FXS device templates.
`tcx_regenerate_web_credentials` Pro · Destructive	DESTRUCTIVE: Regenerate an FXS gateway's web credentials.
`tcx_update_fxs` Pro · Destructive	DESTRUCTIVE: Update an FXS gateway.
`tcx_update_fxs_template` Pro · Write	Update an FXS device template.

SIP settings

Tool	What it does
`tcx_get_codecs_settings` Free · Read-only	Get the PBX SIP codec lists.
`tcx_get_secure_sip_settings` Free · Read-only	Get the secure SIP certificate settings.
`tcx_update_codecs_settings` Pro · Write	Update the PBX SIP codec lists.
`tcx_update_secure_sip_settings` Pro · Destructive	DESTRUCTIVE: Replace the secure SIP certificate and key.

Phones

Tool	What it does
`tcx_bulk_switch_firmware` Pro · Destructive	DESTRUCTIVE: Switch several phones to one firmware.
`tcx_bulk_update_firmware` Pro · Destructive	DESTRUCTIVE: Update the firmware of several phones.
`tcx_clear_firmware` Pro · Destructive	DESTRUCTIVE: Clear the assigned firmware of one phone.
`tcx_delete_device_info` Pro · Destructive	DESTRUCTIVE: Delete a detected device record.
`tcx_get_device_info` Free · Read-only	Get a detected device by Id.
`tcx_list_device_info` Free · Read-only	List detected devices.
`tcx_list_sip_device` Free · Read-only	List phones (SIP devices).
`tcx_move_phone` Pro · Write	Move a phone to another extension.
`tcx_provision` Pro · Destructive	DESTRUCTIVE: Provision a detected device for a user.
`tcx_push_firmware` Pro · Destructive	DESTRUCTIVE: Push a firmware to one phone.

Firmware

Tool	What it does
`tcx_clean_up` Pro · Destructive	DESTRUCTIVE: Clean up the firmware store.
`tcx_delete_firmware` Pro · Destructive	DESTRUCTIVE: Delete a firmware file.
`tcx_get_firmware_state` Free · Read-only	Get the firmware store state.
`tcx_list_firmware` Free · Read-only	List firmware files.
`tcx_push_firmware_for_phones` Pro · Destructive	DESTRUCTIVE: Push a firmware to phones by MAC address.
`tcx_set_as_default` Pro · Write	Set or clear the default flag of a firmware.

Phone templates and settings

Tool	What it does
`tcx_create_phone_template` Pro · Write	Create a phone template.
`tcx_delete_phone_logo` Pro · Destructive	DESTRUCTIVE: Delete a phone logo.
`tcx_delete_phone_template` Pro · Destructive	DESTRUCTIVE: Delete a phone template.
`tcx_get_phone_template` Free · Read-only	Get a phone template by Id.
`tcx_get_phones_settings` Free · Read-only	Get the phone provisioning settings.
`tcx_list_phone_logo` Free · Read-only	List phone logos.
`tcx_list_phone_template` Free · Read-only	List phone templates.
`tcx_update_phone_template` Pro · Write	Update a phone template.
`tcx_update_phones_settings` Pro · Destructive	DESTRUCTIVE: Update the phone provisioning settings.

Recordings

Tool	What it does
`tcx_archive` Pro · Destructive	DESTRUCTIVE: Archive recordings (Recordings route).
`tcx_bulk_recordings_archive` Pro · Destructive	DESTRUCTIVE: Archive the listed recordings.
`tcx_bulk_recordings_delete` Pro · Destructive	DESTRUCTIVE: Delete the listed recordings.
`tcx_download_recording` Free · Read-only	Download a call recording as a file.
`tcx_get_recording_repository_settings` Free · Read-only	Get the recording storage settings.
`tcx_list_recording` Free · Read-only	List call recordings.
`tcx_purge_archive` Pro · Destructive	DESTRUCTIVE: Purge archived recordings.
`tcx_purge_local` Pro · Destructive	DESTRUCTIVE: Purge locally stored recordings.
`tcx_set_recording_repository_settings` Pro · Destructive	DESTRUCTIVE: Set the recording storage settings.
`tcx_transcribe_recordings` Pro · Destructive	DESTRUCTIVE: Transcribe the listed recordings.

Archiving and retention

Tool	What it does
`tcx_archive_chats` Pro · Destructive	DESTRUCTIVE: Start the remote archive run for chats.
`tcx_archive_faxes` Pro · Destructive	DESTRUCTIVE: Start the remote archive run for faxes.
`tcx_archive_recordings` Pro · Destructive	DESTRUCTIVE: Start the remote archive run for recordings.
`tcx_archive_voicemail` Pro · Destructive	DESTRUCTIVE: Start the remote archive run for voicemail.
`tcx_get_chat_log_settings` Free · Read-only	Get the chat log settings.
`tcx_get_remote_archiving_settings` Free · Read-only	Get the remote archiving settings.
`tcx_purge_all_logs` Pro · Destructive	DESTRUCTIVE: Purge all PBX logs.
`tcx_purge_calls` Pro · Destructive	DESTRUCTIVE: Purge call records for a period.
`tcx_purge_chats` Pro · Destructive	DESTRUCTIVE: Purge chat records for a period.
`tcx_update_chat_log_settings` Pro · Destructive	DESTRUCTIVE: Update the chat log settings.
`tcx_update_remote_archiving_settings` Pro · Destructive	DESTRUCTIVE: Update the remote archiving settings.

Voicemail

Tool	What it does
`tcx_create_converter_configuration` Pro · Write	Create a converter configuration.
`tcx_delete_all_user_voicemails` Pro · Destructive	DESTRUCTIVE: Delete every user's voicemail.
`tcx_delete_converter_configuration` Pro · Destructive	DESTRUCTIVE: Delete a converter configuration.
`tcx_get_configured_converters` Free · Read-only	List the configured AI converters.
`tcx_get_connected_converters_data` Free · Read-only	Get the connected AI converters' status.
`tcx_get_converter_request_status` Free · Read-only	Get the converter request status.
`tcx_get_transcribe_languages` Free · Read-only	List transcription languages.
`tcx_get_voicemail_settings` Free · Read-only	Get the voicemail settings.
`tcx_update_voicemail_settings` Pro · Destructive	DESTRUCTIVE: Update the voicemail settings.

Fax

Tool	What it does
`tcx_bulk_fax_delete` Pro · Destructive	DESTRUCTIVE: Delete the listed fax extensions.
`tcx_clean_up_fax` Pro · Destructive	DESTRUCTIVE: Clean up the stored fax files.
`tcx_create_fax` Pro · Destructive	DESTRUCTIVE: Create a fax extension.
`tcx_delete_fax` Pro · Destructive	DESTRUCTIVE: Delete a fax extension.
`tcx_get_fax` Free · Read-only	Get a fax extension by Id.
`tcx_get_fax_by_number` Free · Read-only	Get a fax extension by number.
`tcx_get_fax_files_size` Free · Read-only	Get the size of the stored fax files.
`tcx_get_fax_server_settings` Free · Read-only	Get the fax server settings.
`tcx_init_fax` Free · Read-only	Get a new fax extension record.
`tcx_list_fax` Free · Read-only	List fax extensions.
`tcx_update_fax` Pro · Destructive	DESTRUCTIVE: Update a fax extension.
`tcx_update_fax_server_settings` Pro · Destructive	DESTRUCTIVE: Update the fax server settings.

Call Control API

Tool	What it does
`tcx_cc_get_device` Free · Read-only	Get one device of a DN.
`tcx_cc_get_dn` Free · Read-only	Get one monitored DN with its devices and participants.
`tcx_cc_get_participant` Free · Read-only	Get one call participant on a DN.
`tcx_cc_list` Free · Read-only	List every monitored DN with its devices and participants.
`tcx_cc_list_devices` Free · Read-only	List the devices registered to a DN.
`tcx_cc_list_participants` Free · Read-only	List the call participants on a DN.
`tcx_cc_make_call` Pro · Destructive	DESTRUCTIVE: Place a call from a DN.
`tcx_cc_make_call_from_device` Pro · Destructive	DESTRUCTIVE: Place a call from one device of a DN.
`tcx_cc_participant_action` Pro · Destructive	DESTRUCTIVE: Act on a call participant (drop, answer, divert, route, transfer or attach data).

History views

Tool	What it does
`tcx_download_call_history` Free · Read-only	Download the call history view as a file.
`tcx_download_chat_history` Free · Read-only	Download the chat history view as a file.
`tcx_download_chat_messages_history` Free · Read-only	Download the chat message history view as a file.
`tcx_list_call_history_view` Free · Read-only	List call history view rows.
`tcx_list_chat_history_view` Free · Read-only	List chat history view rows.
`tcx_list_chat_messages_history_view` Free · Read-only	List chat message history view rows.

Scheduled reports

Tool	What it does
`tcx_create_scheduled_report` Pro · Destructive	DESTRUCTIVE: Create a scheduled report.
`tcx_delete_scheduled_report` Pro · Destructive	DESTRUCTIVE: Delete a scheduled report.
`tcx_get_scheduled_report` Free · Read-only	Get a scheduled report.
`tcx_list_scheduled_report` Free · Read-only	List scheduled reports.
`tcx_update_scheduled_report` Pro · Destructive	DESTRUCTIVE: Update a scheduled report.

CDR and call cost settings

Tool	What it does
`tcx_export_call_costs` Free · Read-only	Export the call cost rates as a file.
`tcx_get_cdr_settings` Free · Read-only	Get the CDR output settings.
`tcx_list_call_cost_settings` Free · Read-only	List call cost rates.
`tcx_update_cdr_settings` Pro · Write	Update the CDR output settings.
`tcx_update_cost` Pro · Write	Update call cost rates.

Call log reports

Tool	What it does
`tcx_download_call_log` Free · Read-only	Download the call log report as a file.
`tcx_get_call_log_data` Free · Read-only	Get the call log report.
`tcx_get_call_quality_report` Free · Read-only	Get the quality report for one call.
`tcx_get_old_call_log_data` Free · Read-only	Get the legacy call log report.
`tcx_get_old_call_quality_report` Free · Read-only	Get the quality report for one legacy call.

Call volume and audit reports

Tool	What it does
`tcx_download_audit_log` Free · Read-only	Download the PBX audit log report as a file.
`tcx_download_call_cost_by_extension_group` Free · Read-only	Download the call cost by extension group report as a file.
`tcx_download_get_get_call_distribution` Free · Read-only	Download the call distribution report as a file.
`tcx_download_get_inbound_calls` Free · Read-only	Download the inbound calls report as a file.
`tcx_download_get_outbound_calls` Free · Read-only	Download the outbound calls report as a file.
`tcx_download_get_user_activity` Free · Read-only	Download the user activity report as a file.
`tcx_download_inbound_rules` Free · Read-only	Download the inbound rules report as a file.
`tcx_get_audit_log_data` Free · Read-only	Get the PBX audit log report.
`tcx_get_call_cost_by_extension_group_data` Free · Read-only	Get the call cost by extension group report.
`tcx_get_call_distribution` Free · Read-only	Get the call distribution report.
`tcx_get_inbound_calls` Free · Read-only	Get the inbound calls report.
`tcx_get_inbound_rules_data` Free · Read-only	Get the inbound rules report.
`tcx_get_outbound_calls` Free · Read-only	Get the outbound calls report.
`tcx_get_user_activity` Free · Read-only	Get the user activity report.

Queue reports

Tool	What it does
`tcx_download_abandoned_queue_calls` Free · Read-only	Download the abandoned queue calls report as a file.
`tcx_download_agent_login_history` Free · Read-only	Download the queue agent login history report as a file.
`tcx_download_agents_in_queue_statistics` Free · Read-only	Download the agents in queue statistics report as a file.
`tcx_download_average_queue_waiting_time_report` Free · Read-only	Download the average queue waiting time chart as a file.
`tcx_download_breaches_sla` Free · Read-only	Download the queue SLA breaches report as a file.
`tcx_download_detailed_queue_statistics` Free · Read-only	Download the detailed queue statistics report as a file.
`tcx_download_queue_an_un_calls_report` Free · Read-only	Download the queue answered and unanswered calls chart as a file.
`tcx_download_queue_answered_calls_by_wait_time` Free · Read-only	Download the queue answered calls by wait time report as a file.
`tcx_download_queue_callbacks` Free · Read-only	Download the queue callbacks report as a file.
`tcx_download_queue_failed_callbacks` Free · Read-only	Download the queue failed callbacks report as a file.
`tcx_download_queue_performance_overview` Free · Read-only	Download the queue performance overview report as a file.
`tcx_download_queue_performance_totals` Free · Read-only	Download the queue performance totals report as a file.
`tcx_download_statistic_sla` Free · Read-only	Download the queue SLA statistics report as a file.
`tcx_download_team_queue_general_statistics` Free · Read-only	Download the team queue general statistics report as a file.
`tcx_get_abandoned_queue_calls_data` Free · Read-only	Get the abandoned queue calls report.
`tcx_get_agent_login_history_data` Free · Read-only	Get the queue agent login history report.
`tcx_get_agents_in_queue_statistics_data` Free · Read-only	Get the agents in queue statistics report.
`tcx_get_average_queue_waiting_time_data` Free · Read-only	Get the average queue waiting time chart.
`tcx_get_breaches_sla_data` Free · Read-only	Get the queue SLA breaches report.
`tcx_get_detailed_queue_statistics_data` Free · Read-only	Get the detailed queue statistics report.
`tcx_get_queue_an_un_calls_data` Free · Read-only	Get the queue answered and unanswered calls chart.
`tcx_get_queue_answered_calls_by_wait_time_data` Free · Read-only	Get the queue answered calls by wait time report.
`tcx_get_queue_callbacks_data` Free · Read-only	Get the queue callbacks report.
`tcx_get_queue_failed_callbacks_data` Free · Read-only	Get the queue failed callbacks report.
`tcx_get_queue_performance_overview_data` Free · Read-only	Get the queue performance overview report.
`tcx_get_queue_performance_totals_data` Free · Read-only	Get the queue performance totals report.
`tcx_get_statistic_sla_data` Free · Read-only	Get the queue SLA statistics report.
`tcx_get_team_queue_general_statistics_data` Free · Read-only	Get the team queue general statistics report.

Extension reports

Tool	What it does
`tcx_download_extension_statistics` Free · Read-only	Download the extension statistics report as a file.
`tcx_download_extension_statistics_by_group` Free · Read-only	Download the extension statistics by group report as a file.
`tcx_download_extensions_statistics_by_ring_groups` Free · Read-only	Download the extension statistics by ring group report as a file.
`tcx_download_ring_group_statistics` Free · Read-only	Download the ring group statistics report as a file.
`tcx_get_extension_statistics_by_group_data` Free · Read-only	Get the extension statistics by group report.
`tcx_get_extension_statistics_data` Free · Read-only	Get the extension statistics report.
`tcx_get_extensions_statistics_by_ring_groups_data` Free · Read-only	Get the extension statistics by ring group report.
`tcx_get_ring_group_statistics_data` Free · Read-only	Get the ring group statistics report.

Chat reports

Tool	What it does
`tcx_download_abandoned_chats_statistics` Free · Read-only	Download the abandoned chats report as a file.
`tcx_download_chat_log` Free · Read-only	Download the chat log report as a file.
`tcx_download_queue_agents_chat_statistics` Free · Read-only	Download the queue agents chat statistics report as a file.
`tcx_download_queue_agents_chat_statistics_totals` Free · Read-only	Download the queue agents chat statistics totals report as a file.
`tcx_download_queue_chat_performance` Free · Read-only	Download the queue chat performance report as a file.
`tcx_get_abandoned_chats_statistics_data` Free · Read-only	Get the abandoned chats report.
`tcx_get_chat_log` Free · Read-only	Get the chat log report.
`tcx_get_queue_agents_chat_statistics_data` Free · Read-only	Get the queue agents chat statistics report.
`tcx_get_queue_agents_chat_statistics_totals_data` Free · Read-only	Get the queue agents chat statistics totals report.
`tcx_get_queue_chat_performance_data` Free · Read-only	Get the queue chat performance report.

General settings

Tool	What it does
`tcx_get_general_settings_for_apps` Free · Read-only	Get the app general settings.
`tcx_get_general_settings_for_pbx` Free · Read-only	Get the PBX general settings.
`tcx_update_general_settings_for_apps` Pro · Write	Update the app general settings.
`tcx_update_general_settings_for_pbx` Pro · Write	Update the PBX general settings.

Mail and notifications

Tool	What it does
`tcx_get_email_template` Free · Read-only	Get an email template.
`tcx_get_emergency_notifications_settings` Free · Read-only	Get the emergency notification settings.
`tcx_get_mail_settings` Free · Read-only	Get the PBX mail server settings.
`tcx_get_notification_settings` Free · Read-only	Get the system notification settings.
`tcx_list_email_template` Free · Read-only	List the email templates.
`tcx_set_default` Pro · Destructive	DESTRUCTIVE: Reset an email template to its default.
`tcx_test_email` Pro · Destructive	DESTRUCTIVE: Send a test email.
`tcx_update_email_template` Pro · Write	Update an email template.
`tcx_update_emergency_notifications_settings` Pro · Write	Update the emergency notification settings.
`tcx_update_mail_settings` Pro · Destructive	DESTRUCTIVE: Update the PBX mail server settings.
`tcx_update_notification_settings` Pro · Write	Update the system notification settings.

Logging

Tool	What it does
`tcx_get_logging_settings` Free · Read-only	Get the log retention settings.
`tcx_get_syslog_settings` Free · Read-only	Get the remote syslog settings.
`tcx_test_connection` Pro · Write	Test the connection to a syslog relay.
`tcx_update_logging_settings` Pro · Destructive	DESTRUCTIVE: Update the log retention settings.
`tcx_update_syslog_settings` Pro · Destructive	DESTRUCTIVE: Update the remote syslog settings.

Conferencing

Tool	What it does
`tcx_delete_api_key` Pro · Destructive	DESTRUCTIVE: Delete the conference API key.
`tcx_generate_api_key` Pro · Destructive	DESTRUCTIVE: Generate the conference API key.
`tcx_get_conference_settings` Free · Read-only	Get the conference settings.
`tcx_get_mcu_request_status` Free · Read-only	Get the status of the MCU request.
`tcx_get_mcu_row` Free · Read-only	Get one MCU by GUID.
`tcx_get_mcu_rows` Free · Read-only	List the MCUs.
`tcx_get_onboard_mcu_data` Free · Read-only	List the MCU status reports.
`tcx_get_onboard_meetings` Free · Read-only	List the meetings running on the MCUs.
`tcx_get_web_meeting_zones` Free · Read-only	List the web meeting zones.
`tcx_update_conference_settings` Pro · Destructive	DESTRUCTIVE: Update the conference settings.
`tcx_update_mcu_request_status` Pro · Write	Set the status of the MCU request.

Website links

Tool	What it does
`tcx_bulk_links_delete` Pro · Destructive	DESTRUCTIVE: Delete several website links.
`tcx_create_weblink` Pro · Write	Create a website link (live chat).
`tcx_delete_weblink` Pro · Destructive	DESTRUCTIVE: Delete a website link.
`tcx_get_weblink` Free · Read-only	Get a website link.
`tcx_list_weblink` Free · Read-only	List the website links.
`tcx_update_weblink` Pro · Write	Update a website link.
`tcx_validate_link` Free · Read-only	Check that a friendly name is available.

Hotel

Tool	What it does
`tcx_assign` Pro · Write	Assign a guest to a hotel room.
`tcx_clear` Pro · Destructive	DESTRUCTIVE: Clear the guest of a hotel room.
`tcx_get_hotel_services` Free · Read-only	Get the hotel module settings.
`tcx_update_hotel_services` Pro · Write	Update the hotel module settings.

Microsoft 365

Tool	What it does
`tcx_authorize_presence` Pro · Destructive	DESTRUCTIVE: Authorize Microsoft 365 presence.
`tcx_deauthorize_presence` Pro · Destructive	DESTRUCTIVE: Deauthorize Microsoft 365 presence.
`tcx_get_m365_groups` Free · Read-only	List Microsoft 365 groups.
`tcx_get_m365_users` Free · Read-only	List Microsoft 365 users.
`tcx_get_microsoft365_directory` Free · Read-only	Get the Microsoft 365 directory status.
`tcx_get_microsoft365_integration` Free · Read-only	Get the Microsoft 365 integration settings.
`tcx_get_microsoft_access_token` Free · Read-only	Get the Microsoft access token the PBX holds.
`tcx_get_users_by_principal_names` Free · Read-only	Look up Microsoft 365 users by principal name.
`tcx_test_presence` Pro · Write	Test the Microsoft 365 presence connection.
`tcx_test_subscription` Free · Read-only	Test the Microsoft 365 subscription.
`tcx_update_microsoft365_integration` Pro · Destructive	DESTRUCTIVE: Update the Microsoft 365 integration settings.

Microsoft Teams

Tool	What it does
`tcx_check_fqdn_record` Free · Read-only	Check the DNS record of a Teams SBC FQDN.
`tcx_check_map_users_script` Free · Read-only	Check the Teams user mapping script.
`tcx_get_dial_plan_script` Free · Read-only	Download the Teams dial plan script.
`tcx_get_map_users_script` Free · Read-only	Download the Teams user mapping script.
`tcx_get_microsoft365_teams_integration` Free · Read-only	Get the Teams integration settings.
`tcx_update_microsoft365_teams_integration` Pro · Destructive	DESTRUCTIVE: Update the Teams integration settings.

Google

Tool	What it does
`tcx_get_google_settings` Free · Read-only	Get the Google integration settings.
`tcx_get_google_users` Free · Read-only	List Google users.
`tcx_update_google_settings` Pro · Destructive	DESTRUCTIVE: Update the Google integration settings.

CRM

Tool	What it does
`tcx_delete_crm_contacts` Pro · Destructive	DESTRUCTIVE: Delete the CRM contacts held by the PBX.
`tcx_delete_crm_template` Pro · Destructive	DESTRUCTIVE: Delete a CRM template.
`tcx_ge_crmt_templates` Free · Read-only	List the CRM templates.
`tcx_get_crm_integration` Free · Read-only	Get the CRM integration settings.
`tcx_get_crm_template` Free · Read-only	Get a CRM template.
`tcx_get_crm_template_source` Free · Read-only	Get the source of a CRM template.
`tcx_test` Pro · Write	Test the CRM integration with a lookup.
`tcx_update_crm_integration` Pro · Destructive	DESTRUCTIVE: Update the CRM integration settings.

Amazon AWS

Tool	What it does
`tcx_generate_iam_policy_file` Free · Read-only	Download the AWS IAM policy file.
`tcx_get_amazon_integration_settings` Free · Read-only	Get the Amazon AWS integration settings.
`tcx_update_amazon_integration_settings` Pro · Destructive	DESTRUCTIVE: Update the Amazon AWS integration settings.

Data connector

Tool	What it does
`tcx_get_data_connector_settings` Free · Read-only	Get the data connector settings.
`tcx_synchronize` Pro · Destructive	DESTRUCTIVE: Run the data connector sync now.
`tcx_test_data_connector` Pro · Write	Test the data connector destination.
`tcx_update_data_connector_settings` Pro · Destructive	DESTRUCTIVE: Update the data connector settings.

MCP servers

Tool	What it does
`tcx_get_server_metadata` Free · Read-only	Get an MCP server's OAuth metadata.
`tcx_register` Pro · Destructive	DESTRUCTIVE: Register the PBX with an MCP server.

AI

Tool	What it does
`tcx_add_vector_store_files` Pro · Write	Add files to an AI vector store.
`tcx_batch_delete_files` Pro · Destructive	DESTRUCTIVE: Remove several files from an AI vector store.
`tcx_create_vector_store` Pro · Write	Create an AI vector store.
`tcx_delete_open_ai_file` Pro · Destructive	DESTRUCTIVE: Delete an uploaded AI file.
`tcx_delete_vector_store` Pro · Destructive	DESTRUCTIVE: Delete an AI vector store.
`tcx_delete_vector_store_file` Pro · Destructive	DESTRUCTIVE: Remove a file from an AI vector store.
`tcx_get_ai_resources` Free · Read-only	List the AI models and voices of a provider.
`tcx_get_ai_settings` Free · Read-only	Get the AI settings.
`tcx_get_ai_template_contents` Free · Read-only	Get the contents of an AI agent template.
`tcx_get_current_ai_resources` Free · Read-only	List the current AI models and voices.
`tcx_get_vector_store` Free · Read-only	Get an AI vector store.
`tcx_get_vector_store_files` Free · Read-only	List the files of an AI vector store.
`tcx_get_vector_stores` Free · Read-only	List the AI vector stores.
`tcx_update_ai_settings` Pro · Destructive	DESTRUCTIVE: Update the AI settings.
`tcx_update_vector_store` Pro · Write	Update an AI vector store.

Was this helpful?

Still need help? Ask the team