Home
Getting Started
This section is applicable for users who are new to the Yeastar K2 VoIP PBX API. In this section, we introduces the pre-configurations before using the API, API communication methods and protocols, API request structure, and response result.
API Demo
Yeastar provides an API demo and sample configurations for you to test the API functions with Yeastar K2 VoIP PBX.

API Demo

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

Download API Demo

Unzip the downloaded API demo.
Double click the exe file.
Access the PBX via API interface.
1. Enter the login settings according to your PBX information.
  - Version: Check the , and decide which API version you want to use.
  - API Request: Choose login.
2. In the left-side Text Box, change the API username and password according to the API settings on your PBX.
3. Click Send Request to log in the PBX.
  If logging in successfully, the status will show "Success".
Test API request.
1. Change the API Request type.
2. In the left-side Text Box, change the API request information according to your PBX settings.
3. Click Send Request.
Receive API reports from the PBX.
At the top of the windows, click Start the Server to receive API reports.