Query a Specific Cloud PBX

Query the detailed information of a specific Cloud PBX.

Request URL

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

Request parameters

Path parameter
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
name String The name of the Cloud PBX.
sn String The Serial Number (SN) of the Cloud PBX.
plan String The subscribed plan of the Cloud PBX.
  • Enterprise Plan
  • Ultimate Plan
  • Upgrading to Ultimate Plan
planExpirationDate Long The expiration time of the PBX subscribed plan.
extensionCapacity Long The extension capacity of Cloud PBX.
concurrentCallCapacity Long The concurrent call capacity of Cloud PBX.
recordingStatus String Whether the call recording feature of Cloud PBX is enabled or not.
  • Enabled
  • Disabled
recordingCapacity Long The call recording capacity of the Cloud PBX.
region String The region where the Cloud PBX is launched.
url String The URL of the Cloud PBX.
type String The PBX type.
  • Trial
  • Commercial
expirationDate Long The expiration time of Cloud PBX.
version String The firmware version of Cloud PBX.
group String The group to which the Cloud PBX belongs.
creator Object <Creator_Info> The information of the Cloud PBX creator.
createTime Long The create time of Cloud PBX.
initialStartUpTime Long When the Cloud PBX was first started.
upgradeInPbx String Whether firmware upgrading on PBX side is enabled or not.
  • Enabled
  • Disabled
im String Whether the internal chat feature (IM) of the PBX is enabled or not.
  • Enabled
  • Disabled
passwordlessLogin String Whether passwordless login to PBX is enabled or not.
  • Enabled
  • Disabled
allowSuperiorPasswordlessLogin String Whether passwordless login to PBX for your superior account is enabled or not.
  • Enabled
  • Disabled
provisioningViaTemplate String Whether the PBX is allowed to be provisioned via a template.
  • Enabled
  • Disabled
lastUsedTemplate String The last used provisioning template.
lastUsedTime Long The last time the template was used to provision the PBX.
Creator_Info
Parameter Type Description
firstName String First name.
lastName String Last name.
email String Email address.

Example

Request example

Query the information of a Cloud PBX (ID: 7738).
GET /dm/open_api/v1/cloud_pbx/instances/7738 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0Mzk2OTF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQxNDkxLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI4OTVmM2I4ZC1iYjE5LTQ5Y2ItODE5NC01ZmUxYTNiMTgyNzAiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.nlO7AEithe4a-nAfPSAJv74wnJ0x-oH4jVChniV1Lmk
Response example
HTTP/1.1 200 OK
{
  "data": {
            "cloudPbxId": 7738,
            "pbxStatus": "Running",
            "activationStatus": "Activated",
            "name": "Yeastar P-Series Cloud PBX2",
            "sn": "3658B431119XXXXX",
            "plan": "Ultimate Plan",
           "planExpirationDate": 1638427632,
            "extensionCapacity": 15,
            "concurrentCallCapacity": 15,
            "recordingStatus": "Enabled",
            "recordingCapacity": 500,
            "region": "China(GuangDong)",
            "url": "cloud2.example.yeastarcloud.com",
            "type": "Commercial",
            "expirationDate": 1638427632,
            "version": "84.8.0.25",
            "creator": 
                 {
                   "firstName": "Jane",
                   "lastName": "Smith",
                   "email": "jane@example.com"
                  },
             
             "createTime": 1635749236,
             "initialStartUpTime": 1635749236，
             "upgradeInPbx": "Enabled",
             "im": "Enabled",
             "passwordlessLogin": "Disabled",
             "provisioningViaTemplate": "Enabled",
             "allowSuperiorPasswordlessLogin": "Disabled",
             "lastUsedTemplate": "PCE-Provision-Template",
             "lastUsedTime": 1680138886
            },
  "requestId": "814bc5a4d2f281cd70a77534b4ccf48f",
  "status": "Success",
  "time": 1664440292
}