3CX Powershell Module - Rest API

[xaszy]

Hello toegether,

as some of you might have noticed, there are some chances in the V20 3CX API.
The API was always something not really official and i think still fully isn't, even if there are some pages around here.

As most of the people need the same things i started creating a little powershell module with for today some basic functions as a starter.
If there is public interest in this, i would love to have some knowledge what you would need in the module.

https://github.com/xasz/3CX
https://www.powershellgallery.com/packages/3CX/0.0.5

I just thought i throw that in here, if someone needs it.

 

[Guillaume Bourgeois]

For version v20, the API is officially recognized.
See a comprehensive article that features the API and even the complete list of APIs available to import into Postman.

https://www.3cx.com/docs/configuration-rest-api/
There is even the Swagger documentation available.

Given that 3CX cannot control developers' expertise, no support is offered through tickets, but the community is there to help.

 

[xaszy]

Hello Guillaume,

no i do not want to have any support This is a community project and i am just here to share.
I think i made it more than clear that this is not offical, but most of the powershell modules are not, but still quite welcome by alot of administrators which want everything easy wrapped around a module.

V20 API is officially recognized, but not that long - There are quite some ressouces in the 3CX documentation which are not updated.
Official support is only given for the Configuration API and not for functions like getting Live Active Calls.

I know my module is not big for now, but it will grow with my needs.

 

[NicholasP_3CX]

The API was always something not really official

This is true. Until Version 20 the API was never officially published and documented and released. Now it is.

and i think still fully isn't,

You are incorrect.

As mentioned by @Guillaume Bourgeois the API is available at https://www.3cx.com/docs/configuration-rest-api/

You can also get more information on the PBX via the Call control API. https://www.3cx.com/blog/releases/v20-call-control-api/

Even more information will be coming when the Grafana integration will be released.

https://www.3cx.com/blog/releases/v20-final/

 

[xaszy]

Okay sorry @NicholasP_3CX - I did not clearly express myself.
I am fully talking about REST API - I personally have no intrest in any other control other than REST via https.

And therefore yeah - Yeah the are some information about the Configuration API documented.

So - personally i still not quite sure what you are want to tell me - i think i did not lie or something.

In my opinion - these are the facts:

1. Yeah - I said we have a Configruation API Swagger
2. There is No Rest API / Swagger for the Call Control API
3. There is no powershell scripts example to get someone started here
4. I made my point clear that this is a community project and not more
5. There was a official document on how to get started reverse engeering V18 - which we did internally

So what are you actually trying to tell me here ? I am trying to help people getting started with the 3CX PBS and Powershell.

 

[NicholasP_3CX]

You did mention that it is not fully official, which it is.

I just wanted to set the record straight.

And I did not say you were lying, just that the information was incorrect.

We have nothing against community projects. If we did, we would have deleted the post immediately.

 

[xaszy]

Okay perfect - Sorry, that i got you wrong.
And i think you me two. Because i am talking about the Rest API and this only support Configuration by this date.

I hope there will be more Features in the future, but for now i will add what you support plus whatever i reverse engeer and need

 

[Guillaume Bourgeois]

no i do not want to have any support

Regarding support, I wasn't referring to support for you...
I'm referring to clients with 3CX systems who might later seek support from 3CX for issues with their 3CX systems not caused by your script. If issues arise with their phone system (not caused by your script) and PowerShell has been installed on the phone server, they would need to uninstall all of that to get assistance from 3CX, to eliminate the possibility that the problem is caused by a third-party application like PowerShell, or dependencies on PowerShell, for example.

So, what I meant to say is that I recommend specifying in your instructions not to install PowerShell on the same server as 3CX.
I suggest that you specify in your instructions that users should run your application from an instance outside the 3CX system, rather than directly on 3CX.

This would comply with the 3CX support policies documented here: https://www.3cx.com/ordering/
Users will appreciate your script more if it doesn't restrict the support they can get from 3CX for troubles not caused by your script.

For now, yes, you are right, only the Configuration API is available (management).
Currently, controlling calls via REST API is not possible; everything is behind a socket that I haven't been able to decipher, lol.
By reverse engineering 3CX, I found information related to a WebClient REST API and a CallControl REST API.
Obviously, this doesn’t guarantee that 3CX will develop them, but these traces seem like good indicators of what’s to come.

Thx for all

 

[xaszy]

I hope that nobody are trying to install powershell on the 3CX. That would make the point of haveing a module to use anywhere you want just not make any sense.

 

[xaszy]

There is the first release which actually have quite some usefull functions in it.

 

[xaszy]

There is a new release for the module. Posting Data for example for Adding Contacts is now working.