API Change Logs

When sending an API request, the request address must include the API version. All request samples in this guide use {api version} to represent the API version.

API v1.1.0 (PBX 30.11.0.7)

This API update is compatible with Yeastar S-Series VoIP PBX 30.11.0.7 or later.

  • Added support for Cross-Origin Resource Sharing (CORS), which allows JavaScript clients from a different origin to access PBX APIs.
  • Fixed the issue of Call Transfer API: The API program would be restarted if Call Transfer API was used.
  • Fixed the Extension Status report: PBX didn't send API report when the extension status was changed.
  • Fixed the Apply issue: If the third-party server frequently sends API application requests, the PBX might fail to establish internal calls and external calls.
  • Fixed the issue of DTMF report: The infos parameters were not sent to the 3rd-party server because that the URL was incorrect.
  • Fixed the issue of DTMF report: No infos parameters in the DMTF report when you dialed an external number through IVR and the callee pressed keys following by the IVR prompt.

API v1.1.0 (PBX 30.10.0.67)

This API update is compatible with Yeastar S-Series VoIP PBX 30.10.0.67 or later.

  • Improved the API stability.
  • Fixed the CDR download issue: A “504 gateway timeout” error occurred when requesting to download a CDR file.
  • Fixed the CDR issue: If Control Inbound Call Destination was enabled, the Caller ID was incorrect when the inbound call was made through a VoIP Account trunk.
  • Fixed the CDR issue: The call duration was incorrect.

API v1.1.0 (PBX 30.10.0.59)

API v1.1.0 is compatible with Yeastar S-Series VoIP PBX 30.10.0.59 or later.

Note: We recommend you upgrade to 30.10.0.59 or later to use API v1.1.0.
  • Added API interfaces of Paging Group:
    • Query Paging Group list
    • Query a Paging Group settings
    • Add a Paging Group
    • Edit a Paging Group
    • Delete a Paging Group
  • Added API interfaces of SIP trunk:
    • Query a SIP trunk settings
    • Add a SIP trunk
    • Edit a SIP trunk
    • Delete a SIP trunk
  • Added API interfaces of Outbound Route:
    • Query an Outbound Route settings
    • Add an Outbound Route
    • Edit an Outbound Route
    • Delete an Outbound Route
  • Added API interfaces of Inbound Route:
    • Query an Inbound Route settings
    • Add an Inbound Route
    • Edit an Inbound Route
    • Delete an Inbound Route
  • Added support for perform Call Transfer during an internal call or an external call.
  • Added support for downloading CDR.
  • Fixed the API stability issue: The API would fail to work after a certain time.
  • Fixed the login API interface: Changing password didn't take effect.

API Version v1.0.6

This API version is compatible with Yeastar S-Series VoIP PBX 30.10.0.9 or later.

  • The IP address that exceeds the allowed failed login attempts would be listed on the PBX Block IP Address page.

    You can delete the trusted IP address from the blacklist.

  • Added Transfer Inbound Calls interface.

    Through this interface, inbound calls can be transferred to different destinations, like extension, IVR, queue, etc.

  • Added Transfer Outbound Calls interface.

    Through this interface, outbound calls can be transferred to different destinations, like extension, IVR, queue, etc.

  • Added Hotel Check Out interface.

    Through this interface, PBX will do the following operations for the hotel extension:

    • Empty the extension's voicemail box.
    • Delete the extension's outbound route permissions.
    • Delete the extension's alarms.
    • Reset the extension's Caller ID name setting.
  • Optimized "Prompt Play End" report:

    After an IVR prompt is played, PBX will send an API report to the 3rd-party application server.

  • Optimized API reports: All the API reports include SN parameters.
  • Added the following failure reasons in "Call Failure" report:
    • 404 NOT found
    • 480 Temporarily unavailable
    • 484 Address Incomplete
    • 486 Busy Here
    • 487 Request Terminated
    • 603 Declined
  • Fixed the issue that "Call an External Number via IVR" would not generate CDR.

API Version v1.0.5

This API version is compatible with Yeastar S-Series VoIP PBX 30.8.0.8 or later.

  • Added support for sending API reports to an absolute path of the third-party software.
  • Added support for querying, downloading, and deleting voicemail files.
  • Optimized the Hotel Wake-up Service.
  • Optimized the DTMF output.
  • Fixed the issue that monitoring analog phones would fail.
  • Fixed the issue that the PBX didn't stop sending API reports when the API token expired.
  • Fixed the issue that API reports would be omitted.
  • Fixed the issue on the calls between extensions: The called extension would ring even though the caller didn't pick up the phone to trigger the call.
  • Fixed the issue that the extension status on the PBX Monitor page didn't refresh automatically.

In the Yeastar S-Series VoIP PBX 30.8.0.14, fixed the following API issues:

  • Fixed the issue that PBX would send API reports repeatedly.
  • Fixed the issue that the call could not be terminated if the extension has more than one "Concurrent Registration".
  • Fixed the issue that call pop-up could not work during a call pickup process.
  • Optimized DTMF API reports.

API Version v1.0.4

This API version is compatible with Yeastar S-Series VoIP PBX 30.7.0.35 or later.

  • Added API interface to query queue status and agent status.
  • Added API interface to pause or resume an agent's service.
  • The CDR reports will show DID number and the agent's ring time.
  • Added support for configuring an extension's outbound route.
  • Added support for querying an extension's outbound route.

API Version v1.0.2

This API version is compatible with Yeastar S-Series VoIP PBX 30.7.0.11 or later.

  • Added support for querying the status of dynamic agents.
  • Dynamic agents can log in or log out the queue.
  • Fixed the some API reports didn’t conform to json format.

    To solve this problem, add "version":"1.0.2" in the Login request.

  • Fixed the issue that the PBX would go down if a user called an outbound number that contained letters.
  • Fixed the issue that the third part software could not get information immediately when a call reached the queue.
  • Fixed CDR issue: the CDR was incorrect if an outbound call was automatically answered.
  • Supported for adding an authenticated IP address to get auto recording files from the PBX.

API Version v1.0.1

The first API version for Yeastar S-Series VoIP PBX.

This API version is compatible with Yeastar S-Series VoIP PBX 30.5.0.30.