3CX Integration

This integration pulls data from your 3CX PBX through the XAPI (OData) interface.

What you can sync:

• Call logs: All call history including inbound, outbound, and abandoned queue calls
• Queue performance: Statistics on queue performance, agent queue statistics, ring group statistics, and SLA metrics
• Agent activity: Agent login sessions and queue participation
• Configuration: Users, queues, and trunks configured on your PBX

---

Prerequisites

You’ll need:

1. 3CX administrator access with permissions to create API clients
2. 3CX Enterprise license - XAPI access requires an Enterprise license
3. 3CX instance URL - Your 3CX FQDN (e.g., https://yourcompany.3cx.eu)
4. API client credentials - Client ID and API Key (Client Secret)

---

Setup instructions

Step 1: Create an API client in 3CX

1. Log in to your 3CX Admin Console
2. Go to Integrations > API
3. Click New to create a new API client
4. Fill in the details:
   • Name: Resplendent Data
   • Authentication: Client Credentials
   • Role: Select a role with sufficient permissions (e.g., System Owner)
5. Check XAPI Access Enabled
6. Click Save

Caution

“XAPI Access Enabled” must be checked for this client, and the assigned role needs sufficient permissions. Without this, you will get a 403 error when connecting.

Step 2: Copy your credentials

After saving, copy the Client ID and API Key (this is the Client Secret).

Caution

Your API Key is sensitive. Store it securely and do not share it publicly.

Step 3: Connect in Resplendent Data

1. Go to Settings → Integrations
2. Find 3CX and click Connect
3. Enter your 3CX URL, Client ID, and Client Secret
4. Click Test Connection

---

Available datasets

Dataset	Description	Sync type
CallHistory	Full call log with durations, outcomes, and participant details	Incremental
InboundCalls	Inbound calls with trunk and DID information	Incremental
OutboundCalls	Outbound calls with trunk and cost details	Incremental
AbandonedQueueCalls	Queue calls that were abandoned before being answered	Incremental
SlaBreaches	Calls that exceeded the queue SLA wait time	Incremental
AgentLoginHistory	Agent login and logout sessions per queue	Incremental
QueuePerformance	Queue + extension level performance metrics over the last 30 days	Full sync (snapshot)
AgentQueueStatistics	Agent statistics per queue over the last 30 days	Full sync (snapshot)
RingGroupStatistics	Ring group call counts over the last 30 days	Full sync (snapshot)
QueueSlaStatistics	Queue SLA breach counts over the last 30 days	Full sync (snapshot)
QueueCallbacks	Queue callback statistics over the last 30 days	Full sync (snapshot)
Users	Extensions and users configured on the PBX	Full sync
Queues	Call queues with routing strategy and SLA settings	Full sync
Trunks	SIP trunks with status and configuration	Full sync

Note

Snapshot tables (QueuePerformance, AgentQueueStatistics, RingGroupStatistics, QueueSlaStatistics, QueueCallbacks) are re-pulled in full on every sync over a rolling 30-day window. They do not support incremental sync.

---

Sync behavior and refresh rates

Tier	Refresh rate
Free Forever	60 minutes
Starter	15 minutes
Professional / Business / Starship	60 seconds

Tip

Call history and event tables support incremental sync. After the initial pull, only new and updated records since the last sync are retrieved.

---

Troubleshooting

• 401 Unauthorized: Verify your Client ID and API Key (Client Secret) are copied correctly from the 3CX Admin Console.
• 403 Forbidden: The credentials are valid, but XAPI access is denied. In the 3CX Admin Console under Integrations > API, verify that “XAPI Access Enabled” is checked for this client, the assigned role has sufficient permissions (e.g., System Owner), and your PBX has an Enterprise license.
• Connection timed out: Check that your 3CX URL is correct and accessible from the internet, and that it includes https://.

Related topics

• Data management settings
• Managing your datasets