Before you start, you need to enable API access on the YMP web interface.

If an IP exceeds the allowed failed API login attempts, YMP will block the IP and tag the blocked IP as API-IP. You can delete the blocked API IP if the IP is trusted.

This topic introduces the structure of REST API requests, including request header, request method, and request URL.

The YMP server returns the results in JSON format.

Before your application can successfully request a YMP API, it must obtain an access token that grants access to that API.

Refresh the access token to ensure that your application and the YMP are connected via the API interface.

When you fail to refresh the access token, first check if the refresh token expires. If the refresh token doesn't expire, the refresh token may be stolen, you should revoke the old refresh token, then get a new access token.

Query the information of all created PBXs.

Query the information of a specific PBX.

Query status of all the created PBXs.

Query the status of a specific PBX.

Enable or disable the Linkus Chat, PBX Upgrade, and Call Recording on the PBX.