3CX - A Inofficial Powershell Module for 3CX V20

What does this

This Powershell module contains a set of functions for connecting and talking to a 3CX V20+ System via the REST-API.

Installation

To install the module, you can use the following command:

Install-Module -Name 3CX

https://www.powershellgallery.com/packages/3CX/

Usage

Once the module is installed, you can import it using the Import-Module cmdlet:

Import-Module -Name 3CX

Example System Health

$cred = Get-Credential
Connect-3CX -Credential $cred -APIHost "my.3cx.de"
Get-3CXSystemHealth | ft

If you have Allow access from specific IP Addresses selected, make sure that you add the IP of the server/PC where you're trying to access API.

In web console -> Admin -> Advanced -> Console Restrictions

Example Custom API Call

$cred = Get-Credential
Connect-3CX -Credential $cred -APIHost "my.3cx.de"
Get-3CXResult -Endpoint "/xapi/v1/SystemStatus" | ft

The authentication is handled by Get-3CXResult

Contributing

If you would like to contribute to this project, feel free to submit a pull request or a issue.

License

This project is licensed under the MIT License.

Availible Functions

Connect-3CX
Get-3CXActiveCalls
Get-3CXEventLog
Get-3CXResult
Get-3CXSIPDevice
Get-3CXSystemHealth
Get-3CXSystemStatus
Get-3CXUser
Get-3CXVersion