Jump to main content

| Document Center Yeastar S-Series PBX API

V1.1.0
V2.0.0

Support
Free Trial

Yeastar S-Series VoIP PBX - API

Home
API Interfaces
References of API interfaces and API samples.

API Change Logs
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.
API Overview
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.
Getting Started
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.
API Authentication
API Interfaces
References of API interfaces and API samples.
- Query PBX Information
  Query PBX information, such as firmware version, system time, etc.
- Extension
- Trunk
- Inbound Routes
- Outbound Route
- IVR
- Queue
- Paging Group
- Audio Calls
- Send SMS Messages
  Send SMS messages through a GSM/3G/4G trunk.
- Play Prompts
- Voicemail
- Download Recording Files
  Get a random string of the recording file, then combine the random string with other parameters to form a download link.
- Download CDR Files
  Get a random string of the CDR file, then combine the random string with other parameters to form a download link.
- Hotel Wake-up Service
- Hotel Check Out
  Through this interface, you can perform checkout for the hotel customers.
API Reports
The PBX will send call report to the application server automatically. Call event like call transfer, call failure, call released, etc. will be reported.
Error Code
References of API error codes.

API Interfaces

English 简体中文

English