Cloud Phone System For Modern Businesses

Gain Business Possibility with S-Series VoIP PBX API

Gain 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 service. 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 S50S100S300 firmware version 30.5.0.30 or later.

S-Series VoIP PBX API Developer Guide

Explore More Blogs

Experience Yeastar Cloud PBX Premium yourself for 30 days  

Try first and

decide with certainty

30 Day Free Trial

User Login

Instantaneously receive user login credentials via email once the extension has been deployed by the adminstrator.

Log in conveniently via any web browser for access to the user portal.

Event Center

Determine what events and logs are to be recorded and/or have notifications sent.

Specify particular notifications to be sent to respective authorized personnel.

User Login

Access and manage user settings for softphone application and voicemail.

Manage call routing and presence status for your individual extension.

Retrieve or download your personal call logs and recordings.

User Login

Receive your log-in credentials and set-up guide via email, sent by your admin.

Log-in on any web-browser to get started with PBX set-up.

Configure contacts and personal settings from the web portal.

Auto Provision

Add, remove, or modify IP phone settings from your web interface.

Upgrade IP phone firmware conveniently from your PBX.

Upload various default setting parameters specific to respective IP phone models for greater convenience during set-up.

Contacts

Store, retrieve, and share company contact details easily on your PBX.

Have detailed contact information for your vendors and clients conveniently stored .

Bulk add a list of contacts instead of having to key details in individually.

PBX Monitor

Monitor the status extensions, whether they aren idle, in use, or unavailable.

Know whether your SIP Trunk running properly, or experiencing problems.

Monitor the number of call conferences currently running on your PBX, and their individual durations.

Maintenance

Check for and download firmware upgrades to ensure that your PBX is always up-to-date.

Perform back-ups to prevent data and settings from getting lost.

Perform troubleshooting on your own to debug.

Call Detailed Report

All call log activities are stored, with the option of having audio conversations recorded by default or for specific extensions.

Filter by date, time, or extension number to retrieve specific call logs or recordings

Playback call recordings directly from the PBX or download to store externally.

User Permission

Set up vaious groups of users for allocation to certain sets of access rules.

Determine what features a certain group of extensions can or cannot access.

Determine if users can access, play-back, or download call logs and recordings from the pbx.

Portal Login Page

Receive your administrator log-in credentials and set-up guide via email.

Log-in on any web-browser to get started with PBX set-up.

Installation Wizard will guide you through basic configurations.

Security

Restrict a general group or specific IP addresses to prevent unauthorized access to your PBX.

Determine specific the range of SIP ports for connection between your PBX and endpoints.

Restrict country codes for outbound calls either company-wide or on certain extensions.

Voice Prompt

Upload and designate customised audio recordings at multiple levels of a call journey.

Upload recorded music to fill the silence that would be heard by callers on hold.

Upload customised voice prompts to create a professional call experience.

General

Customize general call preferences either company-wide or for individual extensions.

Set-up feature dial codes for convenient user navigation to specific call features.

Determine how voicemails are retrieved, and also upload custom voicemail recordings.

Call Features

Add multiple automated responses to be played at different phases of a call journey.

Designate specific extensions to ring concurrently based on an external caller's dial pattern.

Customize messages and waiting times to keep external callers engaged when put on hold.

Call Control

Have calls received on specific SIP trunks routed to designated extensions within the PBX.

Set-up dial patterns so that outbound calls are routed to their intended destinations.

Determine how calls are routed and received at different times of a day.

Trunks

Register multiple SIP trunks on a single PBX as needed.

Provision SIP trunk settings and dedicate them to particular extensions.

Bulk add DDIs on each SIP trunk, for allocation to an individual or groups of extensions.

Extensions

View, deploy, add, and remove user extensions within your PBX system.

Allocate and deploy specific extension numbers to respective users via email.

Set-up default ring and presence status settings for individual users.

User Login

Access all company contacts made available to you by the administrator.

Create your own personal contacts list for easy reference and dialing.

Bulk import contact details for convenient data entry.

Extensions

View, deploy, add, and remove user extensions within your PBX system.

Configure default call and user settings for individual extensions.

Customize allocation of user extensions to specific ring groups.

Integrations

Integrate various CRM software for better customer service and satisfaction.

Enable transcription of audio messages into text with integration of third-party transcription service.

Enable API for integration with various third-party integrations for advanced performance such as call center and hotel reception services.

Paging and Intercom

Create different types of paging and intercom broadcast groups for selected extensions.

Set a time schedule to automatically start your broadcast.

System

Provision email SMTP and template settings for event notifications to be sent out.

Manage storage allocation and duration of various types of data being stored on the PBX.

Determine the types of event notifications to be sent out, and the parties receiving them.

IVR

Add various audio voice prompts to be played according to different call scenarios.

Add voice prompts on multiple levels for more effecient and precise inbound call routing.

Voicemail

Customize default voicemail settings for each user extension.

Add various voicemail messages for allocation to different call scenarios and users.

Provision specific rules to how voicemail messages are played over the PBX system for better caller experience.

Reports and CDR

All call log activities are stored, with the option of having audio conversations recorded by default or for specific extensions.

Use intuitive visual call reports, to check various call statistics over extensions, trunks, queues, ring groups, and more.

Call reports can be viewed and downloaded directly from the PBX, or scheduled to be sent via email to respective parties.

Security

Restrict a general group or specific IP addresses to prevent unauthorized access to your PBX.

Limit the number of otbound calls users are allowed to make within a time period to protect against toll fraud.

Restrict certain country codes for outbound calls either company-wide or on certain extensions.

User Login

Determine extension ranges for different functions.

Define use of different voice prompts depending on call scenarios or intended function.

Provision basic and advanced SIP settings to be used on the PBX.

Recordings

Record all calls made on specified trunks, including inbound and outbound calls.

Recordings

Record all calls made on specified extensions, conferences, or call queues.

Maintenance

Check for and download firmware upgrades to ensure that your PBX is always up-to-date.

Perform back-ups to prevent data and settings from getting lost.

Perform troubleshooting on your own to debug.

Trunks

Register multiple SIP trunks on a single PBX as needed.

Different types of trunks can be created, Caller ID can be customized.

Conference

Pre-set conference settings and dial-in passwords for security, and allow internal users to send conference invites to external parties.

Speed Dial

Create multiple speed dial numbers to respective external numbers frequently used for outgoing calls.

Speed dial is activated when the set prefix (default or customized) is dialed.

Ring Group

Create multiple ring groups and determine custom ring strategies and failover settings for each.

Call Queue

Create different call queues with specific ring strategies and failover settings.

Static agents permanently answer calls in queue, while dynamic agents can log in and out. Allocate different extensions to each group.

Determine what actions are to be allowed for Mangers or Agents to manage on the Queue Panel.

Call Control

Have calls received on specific SIP trunks routed to designated extensions or destinations within the PBX.

Set-up dial patterns so that outbound calls are routed to their intended destinations.

Determine how calls are routed and received at different times of a day.

Contacts

Store, retrieve, and share company contact details easily on your PBX.

Organize company contacts into dedicated phonebooks and determine accessibility rights to extension groups for each.

Bulk import a list of contacts instead of having to key details in individually.

Role and Client Permission

Pre-defined user roles within the PBX are conveniently available for allocation, or create your own set of permissions.

Restrict users from viewing specific extensions, departments, or extension groups with Extension Visibility.

Allow or resrict specific users from managing or viewing certain company contacts

Auto Provision

Pre-defined setting parameters specific to respective IP phone models are conveniently available for easy set-up.

IP Phones can be quickly provisioned to your Yeastar PBX with just the pre-defined template and device MAC address.

Deal One View

View cases created for a Deal in One View.

View cases created for a Deal in One View.

View cases created for a Deal in One View.

Deal One View

View cases created for a Deal in One View.

View cases created for a Deal in One View.

View cases created for a Deal in One View.

Deal One View

View cases created for a Deal in One View.

View cases created for a Deal in One View.

View cases created for a Deal in One View.