3CX WebAPI: REST API to connect 3CX with any CRM

Control calls, queues, extensions and the phonebook of 3CX from your CRM, ERP or help desk with simple HTTP requests and JSON responses. A typical integration takes 1–2 weeks.

3CX V20 (V18 is also supported), Basic, PRO and AI editions · Debian and Windows · From €199 per year, see pricing · 15-day free trial
  • Click-to-call
    Call a customer from the CRM in one click: 3CX rings the agent's phone first, then dials the customer.
  • Live call and agent status
    Get active calls, extension and queue status in real time for CRM, dashboards and wallboards.
  • Queue management
    Log agents in and out of queues, add or remove agents and managers right from your CRM.
  • Phonebook sync
    Create, update and find 3CX contacts to keep the 3CX phonebook in sync with your CRM.
  • Extension management
    Create, update and delete extensions, set forwarding status and user rights automatically.
  • Automatic outgoing calls
    Start outgoing calls through an IVR or a queue of call center agents.
Get a 15-day trial

How it works

WebAPI is installed as a service (Windows) or daemon (Debian) on the same server as 3CX and talks to the 3CX core locally. Your system sends HTTP requests from any IP address and gets JSON responses. With the Webhook generator, 3CX call events are sent to your system in real time.
How 3CX WebAPI works: your CRM sends HTTP requests to WebAPI on the 3CX server and receives JSON responses and call events

Click-to-call in one request

Call the customer from extension 102. All methods are described in the 3CX WebAPI documentation.
curl "https://pbx.example.com/webapi/YOUR_ACCESS_KEY/makecall\
?first=102&second=381629759787"

# Response
{
    "chid": "00000000-01dc-226c-d961-c78c00000001"
}
3CX API Documentation        3CX API Download

Why not the official 3CX API?

According to the official 3CX feature list, the 3CX call control API (XAPI / Call API) is available only in the 3CX AI edition. 3CX WebAPI works with the Basic, PRO and AI editions, uses plain HTTP and JSON and comes with documentation, a Postman collection and support.
Ready-made integrations
Our partners have also built integrations with Zoho, MS CRM, SAP CRM, Freshdesk and Odoo ERP.
Get a 15-day trial license: you will receive an email with installation instructions and a trial activation code.
Pricing
Annual licenses priced by the number of simultaneous calls (SC), the same as your 3CX license. Prices for 8 SC:
WebAPI — €199 per year · Webhook — €239 per year · WebAPI + SQL — €299 per year
Bundle WebAPI + Webhook — €438 per year · Bundle WebAPI + SQL + Webhook — €538 per year
  • Annual licenses, support is included
  • The price doesn’t include any taxes or VAT
  • After payment, you will receive a license key for activation
  • To purchase more than one year, contact support
  • All prices · Buy by credit card

Screenshots

Requests to 3CX WebAPI in Postman

Video overview
Requirements
Root (administrator) access to the 3CX server. WebAPI is installed on the same server as 3CX (Debian or Windows). 3CX V20 or V18, Basic, PRO or AI edition. Not available for systems hosted by 3CX (Hosted by 3CX).

FAQ

Another question? Write to support@komplit.eu

Start your 15-day trial

You will receive an email with installation instructions and a trial activation code. Read the documentation or write to support@komplit.eu.
Get a trial Pricing