3CX Web API / 3CX Phone System Web API

Supportet by V16 and v18 Alpha

Attended Transfer bug is fixed with 3CX V16.0.1078

Requirements

• Dot Net Core 3.1 (2.1 for V16.0 - 16.4 use old release of this API)
• 3CXPhoneSystem.ini (Debian User must fix the Path in the ini for the 3cxpscomcpp2.dll)

Installation

Windows

• Download from Microsoft Dot Net Core v3.1
• Install Dot Net Core
• run in cmd dotnet build WebAPICore.csproj

Linux (Debian 10)

wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
apt-get update
apt-get install -y dotnet-sdk-3.1

**Bevore compile, you need to edit the ** WebAPICore.csproj

• remove <Private>false</Private> in for 3cxpscomcpp2
• edit path: <HintPath>..\..\..\Program Files\3CX Phone System\Bin\3cxpscomcpp2.dll</HintPath> to <HintPath>/usr/lib/3cxpbx/3cxpscomcpp2.dll</HintPath>

dotnet build WebAPICore.csproj

Linux

apt-get install -y dotnet-runtime-3.1
dotnet build WebAPICore.csproj

Start the API

Now you can start the API. it is in this path: bin\Debug\netcoreapp3.1 You need the 3CXPhoneSystem.ini in your API folder

For Windows User, the API need Admin rights, so start cmd as Administrator.

dotnet WebAPICore.dll or dotnet WebAPICore.dll Port

Sample: dotnet WebAPICore.dll 8888

Sample debug mode: dotnet WebAPICore.dll 8888 debug

Features

URL: http://ip:port/action/arg1/arg2/.....

Action:

• makecall
• ready
• notready
• logout
• login
• dnregs
• ondn
• getcallerid
• drop
• answer
• record
• transfer
• park
• unpark
• atttrans
• setstatus
• showstatus
• stop