Synway IPPBX API Programming Manual

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.


Synway IPPBX API Programming Manual - cover page
Brand
Synway
Document type
Programming Manual
Language
English
Pages
80
File format
PDF
File size
1 MB
Published
16 October, 2023
Updated
16 October, 2023
MD5 checksum
5BD954E0F1C7319F9A6DE84C641FB240

About this manual

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.

What's inside

  • Overview
  • Enable API Access on IPPBX
  • API Authentication (Login/Logout)
  • Extension Management
  • Trunk Configuration
  • Queue and Agent Control
  • Outbound Routing and IVR
  • Audio Call Control
  • Conference Management
  • Call Records and Events

Specifications

Compatible Version1.2.0_20181026 or above
Communication ProtocolHTTPS
Response FormatJSON format

Frequently asked questions

How do I encrypt the API password for login?

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.

What happens if I enable Control Inbound Call Answering?

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.

What does error code -1 mean?

Error code -1 indicates an unknown issue.

Download PDF (1 MB)

More Synway Manuals


View all Synway manuals →