查询套餐包的订阅信息

查询套餐包的详细订阅信息。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
capacity Object <Capacity> 套餐包容量。
expirationTime Long 套餐包的过期时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
highAvailability String 高可用服务的状态。
  • Enabled：启用
  • Disabled：禁用
whiteLabel String 白标服务的订阅状态。
  • Subscribed：已订阅
Capacity
参数 类型 描述
total Object <Total> 总容量。
used Object <Used> 已使用容量。
available Object <Available> 可用容量。
Total
参数 类型 描述
extensionCapacity Long 总分机数。
concurrentCallCapacity Long 总并发数。
recordingCapacity Long 总通话录音分钟数。
Used
参数 类型 描述
extensionCapacity Long 已使用的分机数。
concurrentCallCapacity Long 已使用的并发数。
recordingCapacity Long 已使用的通话录音分钟数。
frozenExtensionCapacity Long 由于存在待支付订单而被冻结的分机数。
Available
参数 类型 描述
extensionCapacity Long 可用的分机数。
concurrentCallCapacity Long 可用的并发数。
recordingCapacity Long 可用的通话录音分钟数。

示例

请求示例

GET /dm/open_api/v1/subscription HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NTkwMDZ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTYwODA2LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2N2FmZDY4OS01N2M4LTQ3ZjAtYjg5OS04MmJjNjMzZjZhNmQiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.RkrDaoBpepDUY4FurjRsRZ8JvlwVbEdPguWgsHIjFuk
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "capacity": {
      "total": {
        "extensionCapacity": 1400,
        "concurrentCallCapacity": 1400,
        "recordingCapacity": 10000
      },
      "used": {
        "extensionCapacity": 60,
        "concurrentCallCapacity": 10,
        "recordingCapacity": 100,
        "frozenExtensionCapacity": 0
      },
      "available": {
        "extensionCapacity": 1340,
        "concurrentCallCapacity": 1390,
        "recordingCapacity": 9900
      }
    },
    "expirationTime": 1734274802,
    "highAvailability": "Enabled",
    "whiteLabel": "Subscribed"
  },
  "requestId": "8a0f4ed371214dbc3dc6ab67f4c36c37",
  "status": "Success",
  "time": 1663559015
}