查询云 PBX 订阅服务统计

查询云 PBX 订阅服务的统计数据。

请求 URL

GET {base_url}/dm/open_api/v1/subscription/plan_statistics

请求参数

请求头
参数 是否必填 类型 描述
Authorization String 在请求头中传递访问 Token。

格式:Bearer {access_token}

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID,作为该请求的唯一标识,用于快速定位请求。
status String 请求结果。
  • Success:请求成功。
  • Failed:请求失败。
time Long 请求响应的时间。
注: YCM API 响应返回的是时间戳,如有需要,你可以将时间戳转换成具体的日期和时间。详细操作方法,请参见 将时间戳转换为日期和时间
Details
参数 类型 描述
pbxNumber Object <PBX_Num> 订阅企业版 (EP) 或旗舰版 (UP) 的 PBX 数量。
extensionNumber Object <Ext_Num> 企业版 (EP) 或旗舰版 (UP) 的分机数量。
PBX_Num
参数 类型 描述
enterprisePlan Long 订阅企业版 (EP) 的 PBX 数量。
ultimatePlan Long 订阅旗舰版 (UP) 的 PBX 数量。
Ext_Num
参数 类型 描述
enterprisePlan Long 企业版 (EP) 分机数量。
ultimatePlan Long 旗舰版 (UP) 分机数量。

示例

请求示例

GET /dm/open_api/v1/subscription/plan_statistics HTTP/1.1
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NzIzNTN9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTc0MTUzLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZDEyZTE1My1iYjRiLTRjNzUtOTkxZC01ZDFlMzM4YzE3MDYiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.6E_hI3HkpCr8obFYrwH35hWOhB56tNmoT9tW0PTVOOE
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "pbxNumber": {
      "enterprisePlan": 159,
      "ultimatePlan": 24
    },
    "extensionNumber": {
      "enterprisePlan": 1974,
      "ultimatePlan": 257
    }
  },
  "requestId": "2c29caf5e7a313f68acd6800a5286bf9",
  "status": "Success",
  "time": 1664178430
}