Yeastar P-Series PBX System API Introduction
Yeastar P-Series PBX System provides API (Application Programming Interface) to integrate with third-party applications, such as call center, hotel, CRM (Customer Relationship Management), etc.
Note: API functionality is only supported on P550,
P560, and P570.
Requirements
- PBX firmware version: 37.7.0.16 or later.
- API feature on PBX is enabled.
Communication methods
After connected to the PBX using the API interface, a third-party application can implement bidirectional communications with Yeastar P-Series PBX System:
- API request and response
- The third-party application can call APIs to query features, configure parameters, control calls, etc. Every time the application sends an API request, the PBX will return a response with the requested resources.
- Event subscription and event notification
- The third-party application can send messages to subscribe to desired PBX events. In this way, the PBX will proactively send the subscribed events to notify the third-party application about the changes in real-time.
Main features
You can achieve the followings on a third-party application through Yeastar P-Series PBX System APIs.
- Query the PBX parameters and status
- Configure PBX features
- Control calls of the PBX
- Monitor events on the PBX
For more information, see API Interfaces & Events Summary.