API Interfaces & Events Summary

This topic provides the Yeastar P-Series Software Edition API interfaces list and events list.

API Authentication

Table 1.
API endpoint Description
get_token Get API access token.
refresh_token Refresh API access token.
del_token Revoke API access token.

System

Table 2.
API endpoint Description
system/information Query PBX information.
system/capacity Query PBX capacity, including the number of extensions and concurrent calls.
system/get_menuoptions Query the menu option information when creating and updating features.
Note: The interface supports to query the option information (ID, name, or type) of specific features including extension, extension group, organization list, trunk, user role, phonebook, group voicemail, IVR, ring group, queue and agent, conference, and PIN list.

Extension

Table 3.
API endpoint Description
extension/list Query the extension list.
extension/search Search specific extensions.
extension/get Query the information of an extension.
extension/query Query the information of multiple extensions.
extension/create Add an extension.
extension/send_welcome_email Send Linkus welcome emails to specified extensions.
extension/update Edit an extension.
extension/delete Delete an extension.

Organization

Table 4.
API endpoint Description
organization/list Query the organization list.
organization/search Search specific organizations.
organization/get Query the information of an organization.
organization/query Query the information of multiple organizations.
organization/create Add an organization.
organization/update Edit an organization.
organization/delete Delete an organization.

Trunk

Table 5.
API endpoint Description
trunk/list Query the trunk list.
trunk/search Search specific trunks.
trunk/get Query the information of a trunk.
trunk/query Query the information of multiple trunks.
trunk/itsp_list Query the ITSP list of SIP trunks.
trunk/create Add a SIP trunk.
trunk/update Edit a SIP trunk.
trunk/delete Delete a SIP trunk.

Contacts

Table 6.
API endpoint Description
company_contact/list Query the company contacts list.
company_contact/search Search specific company contacts.
company_contact/get Query the information of a company contact.
company_contact/query Query the information of multiple company contacts.
company_contact/create Add a company contact.
company_contact/update Edit a company contact.
company_contact/delete Delete a company contact.

Phonebook

Table 7.
API endpoint Description
phonebook/list Query the phonebook list.
phonebook/search Search specific phonebooks.
phonebook/get Query the information of a phonebook.
phonebook/query Query the information of multiple phonebooks.
phonebook/create Add a phonebook.
phonebook/update Edit a phonebook.
phonebook/delete Delete a phonebook.

Inbound Route

Table 8.
API endpoint Description
inbound_route/list Query the inbound route list.
inbound_route/search Search specific inbound routes.
inbound_route/get Query the information of an inbound route.
inbound_route/query Query the information of multiple inbound routes.
inbound_route/create Add an inbound route.
inbound_route/update Edit an inbound route.
inbound_route/delete Delete an inbound route.

Outbound Route

Table 9.
API endpoint Description
outbound_route/list Query the outbound route list.
outbound_route/search Search specific outbound routes.
outbound_route/get Query the information of an outbound route.
outbound_route/query Query the information of multiple outbound routes.
outbound_route/create Add an outbound route.
outbound_route/update Edit an outbound route.
outbound_route/delete Delete an outbound route.

Recording

Table 10.
API endpoint Description
recording/list Query the recording list.
recording/download Get the download URL to download a recording file.

CDR

Table 11.
API endpoint Description
cdr/list Query the CDR list.
cdr/search Search specific CDR.
cdr/download Get the download URL to download a CDR file.

Call report

Table 12.
API endpoint Description
call_report/list Query the instant call report list.
call_report/download Get the download URL to download an instant call report.
call_schedule_report/list Query the scheduled call report list.
call_schedule_report/download Get the download URL to download a scheduled call report.

Call control

Table 13.
API endpoint Description
call/query Query a specified call or query calls by call types.
call/dial Make a call.
call/accept_inbound Accept an inbound call.
call/refuse_inbound Refuse an inbound call.
call/listen Monitor a call.
call/hold Hold a call.
call/unhold Resume a held call.
call/mute Mute a call.
call/unmute Unmute a call.
call/park Park a call.
call/park_status Query status of parked calls.
call/transfer Transfer a call, including blind transfer and attended transfer.
call/add_member During a call, invite a member to join the call.
call/play_prompt Play custom prompt audio files.
call/hangup Hang up a call.
call/record_start Start call recording.
call/record_pause Pause call recording.
call/record_unpause Resume call recording.

uaCSTA call control

Table 14.
API endpoint Description
uacsta_call/accept Accept an incoming call by uaCSTA control.
uacsta_call/refuse Refuse an incoming call by uaCSTA control.
uacsta_call/hangup Hang up an incoming call by uaCSTA control.

Events

Table 15.
Event Description
(30005) Organization Status Changed Indicate that the organization feature status is changed, and return the current feature status.
(30006) Organization Configuration Changed Indicate that the organization configuration is changed, and return the change information.
(30007) Extension Registration Status Changed Indicate that the extension registration status is changed, and return the extension details.
(30008) Extension Call Status Changed Indicate that the extension call status is changed, and return the current extension call status.
(30009) Extension Presence Status Changed Indicate that the extension presence status is changed, and return the current extension presence status.
(30010) Trunk Registration Status Changed Indicate that the trunk registration status is changed, and return the current trunk status.
(30011) Call Status Changed Indicate that the call status is changed, and return the current call status.
(30012) New CDR Indicate that a new CDR is generated, and return the call details.
(30013) Call Transfer Indicate that a call is transferred, and return the call details.
(30014) Call Forward Indicate that a call is forwarded, and return the call details.
(30015) Call Failed Indicate that a call is failed, and return the call details.
(30016) Inbound Call Invitation Indicate that an inbound call comes from the monitored trunk, and return the call details.
(30017) DTMF Indicate that a key is pressed during a call, and return the call details as well as key pressing information.
(30018) Play Prompt End Indicate the end of prompt playing, and return the call details and the audio prompt name.
(30019) Satisfaction Indicate that caller has completed a satisfaction survey, and return the survey result.
(30020) uaCSTA Call Indicate that a call status of an extension, which is registered to an IP phone, is changed, and return the uaCSTA call details.
(30022) Extension Configuration Changed Indicate that the extension configuration is changed, and return the change information.
(30023) Trunk Configuration Changed Indicate that the trunk configuration is changed, and return the change information.
(30024) No Host in an Audio Conference Indicate that the host leaves the audio conference, and return the audio conference ID as well as host's extension number.