API Overview
Yeastar S-Series VoIP 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.
Compatibility
Yeastar S50, S100, S300 firmware version 30.5.0.30 or later.
System
Function | Endpoint |
---|---|
Query PBX Information | /api/v1.1.0/deviceinfo/query?token={token} |
Extension
Function | Endpoint |
---|---|
Query Extension List | /api/v1.1.0/extensionlist/query?token={token} |
Query Extension Settings | /api/v1.1.0/extension/query?token={token} |
Modify an Extension | /api/v1.1.0/extension/update?token={token} |
Trunk
Function | Endpoint |
---|---|
Query Trunk List | /api/v1.1.0/trunklist/query?token={token} |
Query SIP Trunk Settings | /api/v1.1.0/siptrunk/query?token={token} |
Add a SIP Trunk | /api/v1.1.0/siptrunk/add?token={token} |
Edit a SIP Trunk | /api/v1.1.0/siptrunk/update?token={token} |
Delete a SIP Trunk | /api/v1.1.0/siptrunk/delete?token={token} |
Inbound Route
Function | Endpoint |
---|---|
Query Inbound Route Settings | /api/v1.1.0/inroute/query?token={token} |
Add an Inbound Route | /api/v1.1.0/inroute/add?token={token} |
Edit an Inboud Route | /api/v1.1.0/inroute/update?token={token} |
Delete an Inbound Route | /api/v1.1.0/inroute/delete?token={token} |
Outbound Route
Function | Endpoint |
---|---|
Query Outbound Route Settings | /api/v1.1.0/outroute/query?token={token} |
Add an Outbound Route | /api/v1.1.0/outroute/add?token={token} |
Edit an Outbound Route | /api/v1.1.0/outroute/update?token={token} |
Delete an Outbound Route | /api/v1.1.0/outroute/delete?token={token} |
IVR
Function | Endpoint |
---|---|
Query IVR Settings | /api/v1.1.0/ivr/query?token={token} |
Edit an IVR | /api/v1.1.0/ivr/update?token={token} |
Queue
Function | Endpoint |
---|---|
Query Queue Settings | /api/v1.1.0/queue/query?token={token} |
Edit a Queue | /api/v1.1.0/queue/update?token={token} |
Query Queue Status | /api/v1.1.0/queuestatus/query?token={token} |
Log in a Queue | /api/v1.1.0/queue/add_dynamicagent?token={token} |
Log out a Queue | /api/v1.1.0/queue/del_dynamicagent?token={token} |
Pause an Agent | /api/v1.1.0/queue/pause_agent?token={token} |
Resume an Agent | /api/v1.1.0/queue/unpause_agent?token={token} |
Paging Group
Paging Group | Endpoint |
---|---|
Query Paging Group List | /api/v1.1.0/paginggrouplist/query?token={token} |
Query Paging Group Settings | /api/v1.1.0/paginggroup/query?token={token} |
Add a Paging Group | /api/v1.1.0/paginggroup/add?token={token} |
Edit a Paging Group | /api/v1.1.0/paginggroup/update?token={token} |
Delete a Paging Group | /api/v1.1.0/paginggroup/delete?token={token} |
Make an Announcement | /api/v1.1.0/extension/dial_number?token={token} |
Stop Paging Group Music | /api/v1.1.0/paginggroup/hangup_music?token={token} |
Call Feature
Function | Endpoint |
---|---|
Query Inbound Calls | /api/v1.1.0/inbound/query?token={token} |
Query Outbound Calls | /api/v1.1.0/outbound/query?token={token} |
Make an Internal Call | /api/v1.1.0/extension/dial_extension?token={token} |
Make an Outbound Call | /api/v1.1.0/extension/dial_outbound?token={token} |
Disconnect an Extension's Call | /api/v1.1.0/extension/hangup?token={token} |
Disconnect an Inbound Call | /api/v1.1.0/inbound/hangup?token={token} |
Disconnect an Outbound Call | /api/v1.1.0/outbound/hangup?token={token} |
Hold a Call | /api/v1.1.0/extension/hold?token={token} |
Resume a Held Call | /api/v1.1.0/extension/unhold?token={token} |
Mute an Extension | /api/v1.1.0/extension/mute?token={token} |
Unmute an Extension | /api/v1.1.0/extension/unmute?token={token} |
Listen Monitor | /api/v1.1.0/extension/listen?token={token} |
Whisper Monitor | /api/v1.1.0/extension/whisper?token={token} |
Barge-in Monitor | /api/v1.1.0/extension/barge?token={token} |
Call Transfer | /api/v1.1.0/calltransfer?token={token} |
Transfer Inbound Calls | /api/v1.1.0/inbound/transfer_number?token={token} |
Transfer Outbound Calls | /api/v1.1.0/outbound/transfer_number?token={token} |
Call an Extension via IVR | /api/v1.1.0/ivr/dial_extension?token={token} |
Call an External Number via IVR | /api/v1.1.0/ivr/dial_outbound?token={token} |
Auto Dial (Queue) | /api/v1.1.0/queue/dial_outbound?token={token} |
Auto Dial (Ring Group) | /api/v1.1.0/ringgroup/dial_outbound?token={token} |
Call Back | /api/v1.1.0/outbound/dial_outbound?token={token} |
Accept Inbound Calls | /api/v1.1.0/inbound/accept?token={token} |
Refuse Inbound Calls | /api/v1.1.0/inbound/refuse?token={token} |
Send SMS Messages | /api/v1.1.0/sms/send?token={token} |
Play Prompts
Function | Endpoint |
---|---|
Play Prompt to Extension | /api/v1.1.0/extension/playprompt?token={token} |
Play Prompt to External Number | /api/v1.1.0/outbound/playprompt?token={token} |
Voicemail
Function | Endpoint |
---|---|
Query Voicemail Files | /api/v1.1.0/voicemail/query?token={token} |
Delete Voicemail Files | /api/v1.1.0/voicemail/delete?token={token} |
Download Voicemail Files | /api/v1.1.0/voicemail/get_random?token={token} |
Recording and CDR
Function | Endpoint |
---|---|
Download Recording Files | /api/v1.1.0/recording/get_random?token={token} |
Download CDR Files | /api/v1.1.0/cdr/get_random?token={token} |
Hotel
Function | Endpoint |
---|---|
Add an Alarm | /api/v1.1.0/wakeupcall/create?token={token} |
Query an Alarm | /api/v1.1.0/wakeupcall/query?token={token} |
Edit an Alarm | /api/v1.1.0/wakeupcall/update?token={token} |
Delete an Alarm | /api/v1.1.0/wakeupcall/delete?token={token} |
Hotel Check Out | POST /api/v1.1.0/hotel/checkout?token={token} |