TryLearn More

Use SIP trunks, WebRTC & Apps

Slash your Phone Bill by 80%

Take Control of Calls on 3CX with the Call Control API

On this topic

Take Control of Calls on 3CX with the Call Control API

Introduction

From V15 onwards (Windows Only)

Important

Introduction

The Call Control API is an API available for 3CX V15 and upwards that allows calls to be controlled programmatically. This is an advanced API that requires .NET, C# and telecommunications experience. To integrate with CRM systems, use the 3CX CRM Plugin API. The below outlined API is a private API and may change or be removed without any warning.

“3CX DOES NOT PROVIDE ANY SUPPORT AND MAINTENANCE for this API!”

With the Call Control API, you can:

  • View all active calls on the PBX
  • Take control of a call
  • Transfers
  • Disconnect a call
  • Programmatically configure certain settings in 3CX Phone System

From V15 onwards (Windows Only)

  1. Ensure that your build output path is set to
  2. “C:Program Files3CX Phone SystemInstance1Bin”

Important

  • The API is only available on the server, i.e any application that is using it must be running on the server itself. This is because the service will not accept connections from 0.0.0.0 (ANY IP). Connections are only accepted from 127.0.0.1 (localhost).
  • The Call Control API is only available in commercial editions.

3CX API documentation, including sample applications that make the use of the API self explanatory, can be found here:

3CX API Documentation Package for 3CX V15

The Object model samples included in this package show how to:

  • Add an extension with a set of properties
  • Remove extensions
  • Update extensions
  • Add / remove a digital receptionist
  • Add a Phone by model
  • How to change Parking dial codes
  • How to change Voicemail Box Information
  • Add Fax Extensions
  • Create forwarding rules and profiles
  • Create a new prompt set
  • How to use the call control API to Barge in
  • How to use the call control API to Divert calls
  • How to use the call control API to Drop calls
  • How to use the call control API to perform Listen or whisper functions
  • How to use the call control API to Make calls
  • How to record calls
  • Transferring of calls by DN
  • Transferring of calls by ActiveConnection
  • Schedule a conference

and many other examples…