When sending an API request, the request address must include the API version. All request samples in this guide use {api version} to represent the API version.
Yeastar S-Series VoIP PBX provides API interfaces for you to integrate a 3rd party application server. After the integration, you can achieve variable call features on the 3rd party application server and the PBX will automatically send API reports to the 3rd party application server.
This section is applicable for users who are new to the Yeastar S-Series 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.
Query PBX information, such as firmware version, system time, etc.
Get basic information of the PBX extension list, like extension number, extension name, extension status, type, etc.
Get detailed information about an individual extension or multiple extensions. For example, developers could query the advanced settings of an extension. When there are multiple requests, separate them with commas.
Configure the settings of an individual extension, such as extension number, name, concurrent registrations, email address, mobility extension, etc.
Send SMS messages through a GSM/3G/4G trunk.
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.
Through this interface, you can perform checkout for the hotel customers.
References of API error codes.