Yeastar Blog | Gain More Business Possibility with S-Series VoIP PBX API

Using an API (Application Programming Interface) can transform your business without the need to ‘reinvent the wheel’. And Yeastar S-Series VoIP PBX is here to help. The state-of-the-art built-in API feature allows users to access PBX’s core features – such as initiating calls and sending SMS messages – and integrate them into a third-party web application, software, or device.

API extends the functionality of a VoIP PBX and help create unique services. Its power lies in that it forms the cornerstone that allows developers to create and combine numerous functionalities. Whether you need to implement an IVR service on your website or empower your CRM program with better call management, just take the variables, do some coding, and you can implement it yourselves.

What You Can Achieve with S-Series IP PBX API

Series VoIP PBX APIs are simple to use and powerful in production. You can develop your own customizations with our rich telephony API interfaces. Integration possibilities are immense: web telephony, call analysis, retrieval of call statistics, IP PBX integration through panels – CRM, call center and custom generated. Following are just a few possible use cases.

  • Intelligent Call Process and Control Via a 3rd Party Application

S-Series IP PBX API provides developers with multiple interfaces to establish, terminate or process(transfer, hold, mute, monitor and record)calls based on user input. These API can come in handy in various scenarios.

For example, in some cases when a customer visits a product page on a browser and would like to contact the agents for more information, he/she can simply click the “Call Our Agent” button and enter the phone number. Not shortly after his/her phone will ring and the call with the agent is established. The customer’s action of the number input and click can invoke the corresponding API of the IP PBX and make the IP PBX automatically call the number and connect the call with an available agent. By integrating third-party applications with S-Series VoIP PBX, intelligent call process and control via a third party panel is not a pie in the sky.

  • Customized Voice Services Based on Needs

S-Series VoIP PBX offers developers with API to configure IVR and Queue, and, what’s even better, to send personalized voice messages to a specific extension or customers. With such API, personalized notification systems, phone surveying tools, hotel wake-up or alarm system, and simplified call center can be built as requested.

Suppose you have a call center management tool and would like to do a customer satisfaction survey, then you can utilize the S-Series VoIP PBX API to meet the need. By integrating the call center and PBX via API, a customized customer survey prompt can be configured to be played at the end of every call services. The survey result can be collected with DTMF pressed by callers and will be sent automatically to the call center for analysis. 

  • Statistics Retrieval and Text Messaging

With the S-Series API, you also have the capability to build or extend your applications or devices to include call tracking and text messaging. Tens of programming interfaces are provided for you to securely query call statistics like caller ID, extension status, and queue status. Also, audio files like voicemail and call recording can be accessed and downloaded via API as well.

For text messaging, the S-Series’s “Send SMS Messages” API allows you to send SMS messages through a GSM/3G/4G trunk of the PBX, which can be utilized to introduce new products and services onto the market automatically.

  • Automatic Synchronization with Event Notification

When connecting two devices, real-time data exchange and configuration synchronization are vital to keeping the whole system running smoothly. By API integration, whenever there is a change of S-Series VoIP PBX configuration or there is any call event triggered by API, like call failure or call answered, the PBX will send a report to the third-party application server automatically to help it synchronize the changes timely. Besides, the real-time call event report sent by the PBX also helps third-party applications to keep track of all call status change and make timely response according to the call rule it sets for the PBX (mostly to invoke certain PBX API), which eventually realized a customized call control.

API Interfaces, Demo, and Sample configurations

S-Series VoIP PBX API feature offers great potential for the creation of professional services based on a standard telephony system. Its API interfaces cover a comprehensive feature list, including system, extension, audio calls, queue, IVR and more. Yeastar also provides API demo and sample configurations for you to test the API functions with Yeastar S-Series VoIP PBX.

For a comprehensive view of available API interfaces and how to use the API to connect S-Series VoIP PBX with 3rd party devices, please refer to Yeastar S-Series VoIP PBX API Developers’ Guide here.

Note: the API feature is supported on Yeastar S412, S50, S100, S300 firmware version 30.5.0.30 or later.

S-Series VoIP PBX API Developer Guide

This blog was originally published on Oct.12th, 2017 and updated on Feb. 13th , 2019.