General API settings
Step 1. Go to API settings
Section titled “Step 1. Go to API settings”To enable the API, open the 3CX PBX management console in your browser and go to the Admin section (button at the bottom left), and open the Integrations section.
Path to 3CX API settings
In the Integrations section, select tab API and press the button + Add
Adding a new API integrations
Step 2. Add Integrations
Section titled “Step 2. Add Integrations”Fill in the form fields according to the instructions
Settins API integrations
| Parameter | Description |
|---|---|
| Client ID | It will later be used as the login for the application connection, for example bitrix24. |
| Enable 3CX Configuration API Access | This access is required to retrieve extension numbers, groups, and trunks and is mandatory for the application to work correctly. |
| Department/Role | For each department configured on the PBX, set the role to System Owner. Only this access level provides sufficient permissions for the integration. |
| Enable 3CX Call Control & Chat API Access. | This access is required to receive call information and control calls. |
| Extensions | In the Extensions section, select all extensions, groups, and queues that should be connected to the integration. |
Finally, save the access key by clicking Save button at the top of the window.
Step 3. Copy API key
Section titled “Step 3. Copy API key”When you save new service, a popup with the API key will appear. Copy and save it. You will need it in the next step when configuring the application in Bitrix24.
Copy API key for Bitrix24 integrations
Smart routing settings
Section titled “Smart routing settings”To enable smart routing, also select all trunk numbers (DID Number(s)) that should use this option in the API settings.
Smart routing setting