3cx REST API / Click2Call

[nick123123]

Is there a functionality in 3cx that makes it possible to initiate a call by creating an HTTP request??

 

[SweetAction]

Natively at this time? No.

You could build you own using the 3CX CallControl API

Or,
VOIPTools built a REST API using the API already. While most of the endpoints require a license, MakeCall does not. So you could load their software onto your PBX and have a Endpoint that can make calls.

 

[nick123123]

Natively at this time? No.

You could build you own using the 3CX CallControl API

Or,
VOIPTools built a REST API using the API already. While most of the endpoints require a license, MakeCall does not. So you could load their software onto your PBX and have a Endpoint that can make calls.

Where Can I find the documentation for the 3CX CallControl API?

 

[SweetAction]

Where Can I find the documentation for the 3CX CallControl API?

Ah, 3CX pulled the docs but some searching online + some deductions on your end might lead you to where you need to go.

 

[nick123123]

Ah, 3CX pulled the docs but some searching online + some deductions on your end might lead you to where you need to go.

Thank you but this is probably not an option because it requires an API Key which is probably not available. So the only option for now is using VOIP tools

 

[SweetAction]

Thank you but this is probably not an option because it requires an API Key which is probably not available. So the only option for now is using VOIP tools

The CallControl API does not require an API key at all.

 

[VoIPTools]

I thought it might be helpful for those following this thread to understand some important points:

1. 3CX has stated that they will be releasing a supported REST API that will include basic call control functions including MakeCall, Transfer, Drop, etc. While there has been no new information about an ETA for the release of this API, I still hold out hope that 3CX will release a small subset of their call control API in the future.
   
   
2. In the meantime, we provide an extensive REST API that makes it possible to get/set values in 3CX. One of the available APIs is our MakeCall method. This method is available for free.
   
   
3. If you need to have an external application communicate with 3CX, you can look at the 3CX template based CRM integration and the Call Flow Designer. If those tools do not meet your needs, then you are going to need some kind of relay/proxy that accepts web requests and passes those request on to the 3CX Call Control API. Today, 3CX does not provide that capability, but our VoIPTools Relay does.
   
   
4. If you can get your hands on the 3CX Call Control API, and you are a very capable programmer, you may be able to build your own web gateway. However, you will likely need to invest a considerable amount of effort to make a production-worthy, secure solution. Our API, for example, requires the use of encrypted communications (TLS) and implements JWT authorization. Those capabilities alone were not that straightforward.

 

[nick123123]

I thought it might be helpful for those following this thread to understand some important points:

1. 3CX has stated that they will be releasing a supported REST API that will include basic call control functions including MakeCall, Transfer, Drop, etc. While there has been no new information about an ETA for the release this API, I still hold out hope that 3CX will release a small subset of their call control API in the future.
   
   
2. In the meantime, we provide an extensive REST API that makes it possible to get/set values in 3CX. One of the available APIs is our MakeCall method. This method is available for free.
   
   
3. If you need to have an external application communicate with 3CX, you can look at the 3CX template based CRM integration and the Call Flow Designer. If those tools do not meet your needs, then you are going to need some kind of relay/proxy that accepts web requests and passes those request on to the 3CX Call Control API. Today, 3CX does not provide that capability, but our VoIPTools Relay does.
   
   
4. If you can get your hands on the 3CX Call Control API, and you are a very capable programmer, you may be able to build your own web gateway. However, you will likely need to invest a considerable amount of effort to make a production-worthy, secure solution. Our API, for example, requires the use of encrypted communications (TLS) and implements JWT authorization. Those capabilities alone were not that straightforward.

Hi, thank you for your response, can you please refer me to the MakeCall documentation or instructions?
If it is the ClickToCall - it requires the VoipTools Relay Agent, am I right?

 

[VoIPTools]

Yes, you must install the Relay on your 3CX server. But you raise a good point. The Click-to-Call application demonstrates precisely how you can use the MakeCall method and is free. Further, when you install the Relay, it includes web-based documentation (Swagger) where you can see the required parameters and even test the API right from within the documentation.

 

[nick123123]

Yes, you must install the Relay on your 3CX server. But you raise a good point. The Click-to-Call application demonstrates precisely how you can use the MakeCall method and is free. Further, when you install the Relay, it includes web-based documentation (Swagger) where you can see the required parameters and even test the API right from within the documentation.

But the Relay Agent requires to open port number 8801 on my 3cx server, how can i do that?

 

[VoIPTools]

I would need to know more about your infrastructure to be able to provide an answer to that question, and frankly that's probably outside the scope of these forums. However, in general, I assume you have a firewall in front of your 3CX server. You will need to open the port there. And you will need to open the port on the 3CX server's firewall too (nftables/iptables for Linux and the built-in Defender firewall for Windows).