Before you start, enable API access on the PBX first.

Cross-region Resource Sharing (CORS) is a browser security feature that restricts cross-region HTTP requests that are initiated from scripts running in the browser. If you can not access API and receive an error message indicating the cross-region request was blocked, you need to enable CORS. This topic describes how to enable CORS for a simple request.

If an IP exceeds the allowed failed API login attempts, PBX will block the IP and tag the blocked IP as API-IP. You can delete the blocked API IP if the IP is trusted.

Yeastar K2 VoIP PBX communicates with the 3rd-party application server by two methods.

This topic introduces the structure of API requests, including request method, request URL, and communication protocol.

Yeastar K2 VoIP PBX returns the API responses in JSON format.

After the 3rd-party application server is connected to the Yeastar K2 VoIP PBX via API interface, PBX will automatically sends API reports to the 3rd-party application server.

Yeastar provides an API demo and sample configurations for you to test the API functions with Yeastar K2 VoIP PBX.

Enable API access on the Yeastar K2 VoIP PBX, then access the PBX by the API username and the encrypted MD5 API password.

Query PBX information, such as firmware version, system time, etc.

Get a random string of the recording file, then combine the random string with other parameters to form a download link.

Get a random string of the CDR file, then combine the random string with other parameters to form a download link.

The PBX will send a report to the application server when the extension status changes.

The PBX will send a report to the application server when the called party (extension/inbound call) rings back the calling party.

The PBX will send a report to the application server when an extension answers a call. Answering call (the called party) and call answered (the calling party) coexist. In the report, the calling party's number will appear first.

The PBX will send a report to the application server when the calling party's call is answered. Answering call (the called party) and call answered (the calling party) coexist. In the report, the calling party's number will appear first.

The PBX will send two "BYE" reports to the 3rd-party application server when a call is released. In the first "BYE" report, the user who releases the call will appear first.

When there is a call transferred inside the PBX, the PBX will send a report to the application server.

Generally, call failure event will appear in the response message of the API request. In certain circumstances, the PBX will send the report. Call failure is defined as calls that are failed to connect. Failure of calls initiated manually and by the API will both be reported.

This event is used report key pressed (DTMF information) during a call.

CDR is raw data of all call activities. Records of all calls from the beginning to the end will be kept. When a call is released, the PBX will send a report to the application server in real time.

If the trunk's API has Control Inbound Call Answering enabled, then whenever there's a call to this trunk, the PBX will send an INVITE event to the application server.

If the trunk's API has Control Inbound Call Destination enabled, then when the trunk answers the call, the PBX will send an Incoming event to the application server.

Report the event when the prompt played to the extension and the external number ends.

Once the DTMF pressed is collected from callers, API will send the customer satisfaction survey result to the client automatically.

Connect Hotel Property Management System and Yeastar K2 VoIP PBX via API to achieve automate hotel operations, such as extension management, wake-up service, statistics for call and mini-bar consumption, change of room's clean status, check-out and so on.

Connect Dispatching System and Yeastar K2 VoIP PBX via API to dispatch tasks by one-way paging, one-way multicast paging, or two-way intercom via phone terminals.

Connect Call Center System and Yeastar K2 VoIP PBX via API to achieve multiple operations, such as automatic call distribution, agent management, daily communication, and satisfaction survey.

Connect Alarm System and Yeastar K2 VoIP PBX via API to provide alarm service via IVR prompts.

Connect Yeastar K2 VoIP PBX and Application System to offer customers voice interactive service.