3CX API - what are they and what to do with them? (Part 1)
If an ordinary PBX is no longer cool for you, then the word INTEGRATION appears in the lexicon. This word for many is associated with complex processes, long development and high budgets. Following INTEGRATION, the API usually runs, the same set of procedures and tools with which our IP PBX fits in with some third-party application.
The meaning of INTEGRATION almost always comes down to the transfer from the IP PBX to the application side (usually some CRM) numbers when an incoming call (well, the fact of the call itself is obvious) and transferring the same number from the application to the IP PBX, outgoing. Further, the application itself decides what to do with this number:
Less commonly INTEGRATION implies embedding a wider functionality:
')
Here, in fact, we transfer our CRM softphone functionality.
With it you can:
It all works quite simply, for example, in order to call we type in the browser such a string
First, the call will arrive to the initiator, put it on hold, then 3CX will dial up to the deleted number and combine the calls.
a full description of the variables is here- http://www.3cx.com/blog/docs/3cx-http-api/
You can use in any browser CRM. Cons - interaction only in the direction of the PBX. It is impossible to send a notification to the client about an incoming call in this way.
With it you can:
The CRM API is essentially a module for a native softphone - 3CX Phone for Windows. To develop a plugin you need to own Microsoft Visual Studio. A DLL is made, which is written in the softphone configuration file.
The description of commands with examples is here- http://www.3cx.com/blog/docs/3cxphone-for-windows-api/
You can apply anywhere. It must be remembered that this API requires a softphone, this is a plus at the same time: it takes on the client - server interaction, and minus - the softphone is needed anyway.
Call Control API is available for 3CX Phone System starting with version 11 and higher and allows you to programmatically control calls. Development requires experience with .NET and C #.
With it you can:
Using this API is intended for use in large projects. The main difference from the rest of the API is that the interaction goes directly with the PBX (with the server part), and not with the client.
A description of the commands with examples is here - http://www.3cx.com/blog/docs/call-control-api/
All boxed integration in the form of plug-ins to 3CX Phone.
Actions on the CRM side are configured in 3CXPhone.
Integration with Microsoft Outlook and Microsoft Office 365 is available for any commercial release of the 3CX Phone System commercial license. The remaining plugins require a CRM 3CX Phone System PRO version. It is worth noting that the number of users of these plugins is not licensed.
In addition to the already specified Outlook and Office, the following CRMs are supported:
Each plug-in is installed from a common distribution and has 2 parts, the first is 3CXPlugin for the system and the second is the customization package for the CRM system and a small manual on how to install it, so that the CALL button appears in the interface.
Download 3CXPlugins here .
In the second part of the article I will give a selection of third-party plug-ins and modules implemented on the 3CX API.
The meaning of INTEGRATION almost always comes down to the transfer from the IP PBX to the application side (usually some CRM) numbers when an incoming call (well, the fact of the call itself is obvious) and transferring the same number from the application to the IP PBX, outgoing. Further, the application itself decides what to do with this number:
- Open card found by number
- Make an entry in the log
- send a message
- Etc.
Less commonly INTEGRATION implies embedding a wider functionality:
- Operator Line Status Management
- Work with your own calls
- Work with colleagues calls
- Work with conferences
- Work with the phone book
- Etc.
')
Here, in fact, we transfer our CRM softphone functionality.
What are the 3CX API
HTTP API
With it you can:
- Make a call from a 3CX subscriber (to an internal or external number)
- Disable subscriber
- Enable subscriber
- Disable external calls to the subscriber
- Enable external calls to the subscriber
- Enable call recording for the subscriber
- Disable call recording for the subscriber
It all works quite simply, for example, in order to call we type in the browser such a string
IP- -3CX:5000/ivr/PbxAPI.aspx?func=make_call&from=--&to=-&pin=
First, the call will arrive to the initiator, put it on hold, then 3CX will dial up to the deleted number and combine the calls.
a full description of the variables is here- http://www.3cx.com/blog/docs/3cx-http-api/
You can use in any browser CRM. Cons - interaction only in the direction of the PBX. It is impossible to send a notification to the client about an incoming call in this way.
CRM API
With it you can:
- Make calls from a third-party application
- Notifications about changing call status (connection established, dialing, dialing, etc.)
- Subscriber status notifications (logged in, logged out, no connection to PBX)
The CRM API is essentially a module for a native softphone - 3CX Phone for Windows. To develop a plugin you need to own Microsoft Visual Studio. A DLL is made, which is written in the softphone configuration file.
The description of commands with examples is here- http://www.3cx.com/blog/docs/3cxphone-for-windows-api/
You can apply anywhere. It must be remembered that this API requires a softphone, this is a plus at the same time: it takes on the client - server interaction, and minus - the softphone is needed anyway.
CALL CONTROL API
Call Control API is available for 3CX Phone System starting with version 11 and higher and allows you to programmatically control calls. Development requires experience with .NET and C #.
With it you can:
- View all active calls on PBX
- Taking control of calls
- Call Transfer
- Hang up
- Change settings 3CX Phone System
- And more pieces of 30 different functions
Using this API is intended for use in large projects. The main difference from the rest of the API is that the interaction goes directly with the PBX (with the server part), and not with the client.
A description of the commands with examples is here - http://www.3cx.com/blog/docs/call-control-api/
Integration with CRM available out of the box
All boxed integration in the form of plug-ins to 3CX Phone.
- Click to Call - the ability to dial a number with one click from CRM.
- Call Pop-up - automatic display of a contact card based on caller ID.
- Call Journals - keeping a call history in CRM.
Actions on the CRM side are configured in 3CXPhone.
Integration with Microsoft Outlook and Microsoft Office 365 is available for any commercial release of the 3CX Phone System commercial license. The remaining plugins require a CRM 3CX Phone System PRO version. It is worth noting that the number of users of these plugins is not licensed.
In addition to the already specified Outlook and Office, the following CRMs are supported:
- Microsoft Dynamics
- Google Contacts
- Salesforce
- Sugarcrm
- Sage CRM
Each plug-in is installed from a common distribution and has 2 parts, the first is 3CXPlugin for the system and the second is the customization package for the CRM system and a small manual on how to install it, so that the CALL button appears in the interface.
Download 3CXPlugins here .
In the second part of the article I will give a selection of third-party plug-ins and modules implemented on the 3CX API.
Source: https://habr.com/ru/post/265653/
All Articles