Query the P-Series Cloud Edition Feature Plan Statistics
Query the statistics of the subscribed P-Series Cloud Edition feature plan.
Request URL
GET {base_url}/dm/open_api/v1/subscription/plan_statistics
Request parameters
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:
|
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 |
---|---|---|
pbxNumber | Object <PBX_Num> | The number of PBXs with Enterprise Plan or Ultimate Plan subscribed. |
extensionNumber | Object <Ext_Num> | The number of extensions for the subscribed Enterprise Plan or Ultimate Plan. |
- PBX_Num
-
Parameter Type Description enterprisePlan Long The number of PBXs with Enterprise Plan subscribed. ultimatePlan Long The number of PBXs with Ultimate Plan subscribed. - Ext_Num
Parameter Type Description enterprisePlan Long The number of extensions for Enterprise Plan. ultimatePlan Long The number of extensions for Ultimate Plan.
Example
Request example
GET /dm/open_api/v1/subscription/plan_statistics HTTP/1.1
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NzIzNTN9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTc0MTUzLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZDEyZTE1My1iYjRiLTRjNzUtOTkxZC01ZDFlMzM4YzE3MDYiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.6E_hI3HkpCr8obFYrwH35hWOhB56tNmoT9tW0PTVOOE
Response
exampleHTTP/1.1 200 OK
{
"data": {
"pbxNumber": {
"enterprisePlan": 159,
"ultimatePlan": 24
},
"extensionNumber": {
"enterprisePlan": 1974,
"ultimatePlan": 257
}
},
"requestId": "2c29caf5e7a313f68acd6800a5286bf9",
"status": "Success",
"time": 1664178430
}