Jump to main content

| Document Center Yeastar Cloud PBX API

V1.1.0
V2.0.0

Support
Free Trial

Yeastar Cloud PBX - API

Home
API Reports
The PBX will send call report to the application server automatically. Call event like call transfer, call failure, call released, etc. will be reported.

API Change Logs
API Overview
Yeastar Cloud PBX provides API interfaces for you to integrate a 3rd party application server. After the integration, you can achieve variable call features on the 3rd party application server and the PBX will automatically send API reports to the 3rd party application server.
Getting Started
This section is applicable for users who are new to the Yeastar Cloud PBX API. In this section, we introduces the pre-configurations before using the API, API communication methods and protocols, API request structure, and response result.
API Authentication
API Interfaces
References of API interfaces and API samples.
API Reports
The PBX will send call report to the application server automatically. Call event like call transfer, call failure, call released, etc. will be reported.
- 'System Startup' Report
- 'Changed Settings' Report
- 'Changed Extension Status' Report
  The PBX will send a report to the application server when the extension status changes.
- 'Ringing' Report
- 'Ring Back' Report
  The PBX will send a report to the application server when the called party (extension/inbound call) rings back the calling party.
- 'Answer a Call' Report
  The PBX will send a report to the application server when an extension answers a call. Answering call (the called party) and call answered (the calling party) coexist. In the report, the calling party's number will appear first.
- 'Call Answered' Report
  The PBX will send a report to the application server when the calling party's call is answered. Answering call (the called party) and call answered (the calling party) coexist. In the report, the calling party's number will appear first.
- 'Call Released' Report
  The PBX will send two "BYE" reports to the 3rd-party application server when a call is released. In the first "BYE" report, the user who releases the call will appear first.
- 'Call Transfer' Report
  When there is a call transferred inside the PBX, the PBX will send a report to the application server.
- 'Call Failure' Report
  Generally, call failure event will appear in the response message of the API request. In certain circumstances, the PBX will send the report. Call failure is defined as calls that are failed to connect. Failure of calls initiated manually and by the API will both be reported.
- 'Keypress' Report
  This event is used report key pressed (DTMF information) during a call.
- CDR Report
  CDR is raw data of all call activities. Records of all calls from the beginning to the end will be kept. When a call is released, the PBX will send a report to the application server in real time.
- 'Inbound Call Request' Report
  If the trunk's API has Control Inbound Call Answering enabled, then whenever there's a call to this trunk, the PBX will send an INVITE event to the application server.
- 'Inbound Call' Report
  If the trunk's API has Control Inbound Call Destination enabled, then when the trunk answers the call, the PBX will send an Incoming event to the application server.
- 'Prompt Play End' Report
  Report the event when the prompt played to the extension and the external number ends.
- 'Customer Satisfaction Survey Result' Report
  Once the DTMF pressed is collected from callers, API will send the customer satisfaction survey result to the client automatically.
Error Code
References of API error codes.

API Reports

The PBX will send call report to the application server automatically. Call event like call transfer, call failure, call released, etc. will be reported.

English 简体中文

English

Copyright 2006-2020 Yeastar Information Technology Co., Ltd. Terms of Use | Privacy Policy | Cookie Policy