查询 YCM 用户的订阅信息

查询指定 YCM 用户云 PBX 套餐包的订阅信息。

请求 URL

GET {base_url}/open_api/v1/users/{userId}/subscription_info

请求参数

路径参数
参数 是否必填 类型 描述
userId 是 Long YCM 用户 ID。
注： 可使用 查询所有 YCM 用户 接口查询用户 ID。
请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
totalExtensions Integer 总的分机数。
usedExtensions Integer 已使用的分机数。
totalConcurrentCalls Integer 总的并发数。
usedConcurrentCalls Integer 已使用的并发数。
totalRecordings Integer 总的通话录音分钟数。
usedRecordings Integer 已使用的通话录音分钟数。
minimumExtPerPbx Integer 每台 PBX 最小分机数。
highAvailability String 高可用服务是否已启用。
  • Enabled：启用
  • Disabled：禁用
whiteLabel String 白标服务是否已启用。
  • Enabled：启用
  • Disabled：禁用

示例

请求示例

查询 YCM 用户 (ID：13123) 云 PBX 套餐包的订阅信息。
GET /dm/open_api/v1/users/13123/subscription_info HTTP/1.1
Host: ycm.yeastar.com
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQzNDIzOTB9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0MzQ0MTkwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI1ODA1OWRjMC05NWQ4LTQzYWYtOGMyNi1iZDAzOWEwMGU3NjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.4tE1BwhZkkxLHuwfyU989EgQp9VvPWwthplR-8Bnsls
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "totalExtensions": 50,
    "usedExtensions": 0,
    "totalConcurrentCalls": 5,
    "usedConcurrentCalls": 0,
    "totalRecordings": 50,
    "usedRecordings": 0,
    "minimumExtPerPbx": 10,
    "highAvailability": "Enabled",
    "whiteLabel": "Enabled"
  },
  "requestId": "b350c75fbf2213fda3f0cc61d43f977e",
  "status": "Success",
  "time": 1664432266
}