3CX WEB API Windows installation guide

Created by Oleg Agapov, Modified on Wed, 08 Mar 2023 at 08:52 AM by Oleg Agapov

1. Upload files

Create C:\Program Files\3CX Phone System\Bin\webapi

Download link https://download.creomate.com/webapi_win_en.zip

Place files in a folder:

  • TCXWebAPI.exe
  • ffmpeg.exe
  • TCXWebAPI.ini
  • 3cxpscomcpp2.dll
  • tcxpscom_native.dll
  • sl.dll
  • AuthKeys.csv
  • TCXWebAPI.ini
  • AllowedIP.txt

Create C:\Program Files\3CX Phone System\Bin\webapi\mp3 (for MP3 records) 

Create C:\3CXlogs\ (for log files)

Don't forget  grant write permissions to mp3 and log folders

2. Create Windows Service WebAPI

Execute in command shell (not PowerShell) as Administrator:

sc create webapi binpath= "\"C:\Program Files\3CX Phone System\Bin\webapi\TCXWebAPI.exe\" --urls=" displayname= "3CX WebAPI" start= auto obj= "NT AUTHORITY\LocalService"

Start WebAPI Service

sc start webapi

Stop WebAPI Service

sc stop webapi

Delete WebAPI Service

sc delete webapi

3. Edit NGINX.conf file (must be performed after each update 3CX)

C:\Program Files\3CX Phone System\Bin\nginx\conf\nginx.conf (the file is write protected)


 client_max_body_size 300m;
 root "C:/ProgramData/3CX/Data/Http/wwwroot";


location ~ ^/webapi/?(.*) {
include "shared-headers.conf";
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_buffering off;

Restart nginx Service (3CX Phone System Nginx Webserver)

sc stop nginx
sc start nginx

4. Checking

From public network:

https://{fqdn and port 3СХ Phone}/webapi/tcx

5. Activate a license

https://{FQDN and port 3СХ}:5001/webapi/admin/

login - TCXWebAPI
password- Activate (after activation will be license XXXX-XXXX)

For trial activation use NHQE-QRND-TRIAL (only once)

6. Enjoy :-)

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article