3CX WEB API Windows installation guide

Make sure that the 3CX server is installed and activated

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) 

Don't forget to grant write permissions C:\Program Files\3CX Phone System\Bin\webapi\

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=http://127.0.0.1:8081" 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)

After:

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

Add:

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_pass http://127.0.0.1:8081/webapi/$1$is_args$args;
proxy_buffering off;
proxy_read_timeout 300;

proxy_connect_timeout 300;
proxy_send_timeout 300;

}

Restart nginx Service (3CX Phone System Nginx Webserver)

sc stop nginx
sc start nginx

4. Checking

http://127.0.0.1:8081/webapi/tcx

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 :-)