Enable Yeastar P-Series Cloud Edition API

Before establishing a connection between a third-party application and Yeastar P-Series Cloud Edition, you need to enable API feature and configure relevant settings on the PBX.

Procedure

  1. Log in to PBX web portal, go to Integrations > API.
  2. Turn on API.

  3. Optional: Enable the IP Restriction, and add at least one permitted IP address and subnet mask.

    If you set up this option, only the permitted IP address(es) can use the API feature.

  4. In the Advanced Settings section, enable the status monitor for extensions and trunks as needed.
    1. Go to the Extension Status Monitor tab, enable the monitoring feature for extensions.

      Table 1.
      Setting Description
      Registration Status Monitor If enabled, when the extension registration status is changed, the PBX will send an event report 30007 to the third-party application.
      Call Status Monitor If enabled, when the extension call status is changed, the PBX will send an event report 30008 to the third-party application.
      Presence Status Monitor If enabled, when the extension presence status is changed, the PBX will send an event report 30009 to the third-party application.
    2. Go to the Trunk Status Monitor tab, enable the monitoring and inbound call control features for desired trunks.

      Table 2.
      Setting Description
      Call Status Monitor If enabled, when the trunk registration status is changed, the PBX will send an event report 30010 to the third-party application.
      Control Inbound Call If enabled, when an inbound call comes from the monitored trunk, the followings can be implemented:
      • The PBX will send an event report 30016 to the third-party application.
      • The third-party application can use the API interfaces to control the inbound calls, including accept and refuse inbound calls.
  5. Click Save.

What to do next

  1. Obtain the Client ID and Client Secret from the PBX, and use the credentials to request for the API access token. For more information, see Get Access Token.

  2. Use the access token to send requests and monitor API events for seamless integration.

    This guide provides examples for sending requests and monitoring API events via Postman. For more information, see the following topics: