Query the Status of a Cloud PBX

Query the activation status and running status of a specific Cloud PBX.

Request URL

GET {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/status

Request parameters

Path parameters
Parameter Required Type Description
cloudPbxId Yes Long The ID of the Cloud PBX.
Note: You can query the Cloud PBX ID using Query All the Cloud PBXs.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
data Object <Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
cloudPbxId Long The ID of the Cloud PBX.
pbxStatus String The running status of the Cloud PBX.
  • Stopped
  • Starting
  • Running

  • Upgrading

  • Restoring
  • Provisioning
activationStatus String The activation status of the Cloud PBX.
  • Activated
  • Unactivated

Example

Request example

Query the status of a Cloud PBX (ID: 7738).
GET /dm/open_api/v1/cloud_pbx/instances/7738/status
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NDE5NjF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQzNzYwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwNzM2ZDJkMS0wMDZjLTQ1ZmUtYTBiZS0zNWNjNjIxNTVmYjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.h3Hz2suOlciWP9X8bxrAtsOaoCGEFad76kWc3xxk-nQ
Response example
HTTP/1.1 200 OK
{
  "data": {
    "cloudPbxId": 7738,
    "pbxStatus": "Running",
    "activationStatus": "Activated"
  },
  "requestId": "9a83eba1eda1cc4d12c0cc17db543fa5",
  "status": "Success",
  "time": 1664441966
}