查询云 PBX 的激活信息

查询未激活的云 PBX 的激活信息 (包括激活链接和激活码)。

请求 URL

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

请求参数

路径参数
参数 是否必填 类型 描述
cloudPbxId 是 Long 未激活的云 PBX 的 ID。
注： 可使用 查询所有云 PBX 接口查询云 PBX 的 ID 和激活状态。
请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详细信息。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
cloudPbxId Integer 云 PBX 的 ID。
activationUrl String PBX 的激活链接。
注： 激活链接 7 天内有效。
activationCode String PBX 的激活码。
注： 激活码只能使用一次。

示例

请求示例

查询未激活云 PBX (ID：116671) 的激活信息。

GET /dm/open_api/v1/cloud_pbx/instances/116671/activation_info
Host: ycmtest.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NDE5NjF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQzNzYwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwNzM2ZDJkMS0wMDZjLTQ1ZmUtYTBiZS0zNWNjNjIxNTVmYjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.h3Hz2suOlciWP9X8bxrAtsOaoCGEFad76kWc3xxk-nQ

Response example

{
  "data": {
    "cloudPbxId": 116671,
    "activationUrl": "https://unactivatedpbx.example.yeastarcloud.com/activation?code=FMY5wFNH7XC4X4t8ZMhD3T5kuNhwLEMPQW0dhH30AfM79MkzNrMsMHgGeZkLqJPW",
    "activationCode": "33gsnr3e"
  },
  "requestId": "7c39319bb125555d99c9ef143efbe936",
  "status": "Success",
  "time": 1700105153
}