This API manual provides detailed instructions on the API call process, parameter description, and return result of Synway IPPBX, including API authentication, extension, trunk, queue, outbound routing, IVR, alarm service and audio calls.
The Synway IPPBX provides API interfaces to allow third-party applications to operate on the system. Supported features include answering calls, hanging up calls, managing extensions and trunks, controlling queues, handling IVR settings, and monitoring audio calls. The manual covers both request-based interactions from a client server and event report mechanisms initiated by the IPPBX.
| Compatible Version | 1.2.0_20181026 or above |
|---|---|
| Communication Protocol | HTTPS |
| Response Format | JSON format |
You need to encrypt the API password with MD5 first, and use the MD5 password to log in. The MD5 password should be in the format of 32 lowercase letters.
If enabled, users can answer or decline inbound calls on the third-party application within 10 seconds. If not handled, the call is automatically answered.
Error code -1 indicates an unknown issue.