查询指定云 PBX

查询指定云 PBX 的详细信息。

请求 URL

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

请求参数

路径参数


参数	是否必填	类型	说明
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	Long	云 PBX 的 ID。
pbxStatus	String	云 PBX 的运行状态。 `Stopped`：PBX 停止运行 `Starting`：PBX 正在启动 `Running`：PBX 正在运行 `Upgrading`：PBX 正在升级 `Restoring`：PBX 正在还原数据 `Provisioning`: PBX 正在部署中
activationStatus	String	云 PBX 的激活状态。 `Activated`：已激活。 `Unactivated`：未激活。
name	String	云 PBX 的名称。
sn	String	云 PBX 的序列号。
plan	String	云 PBX 的订阅服务： `Enterprise Plan`：企业版 `Ultimate Plan`：旗舰版 `Upgrading to Ultimate Plan`：正在升级到旗舰版
planExpirationDate	Long	云 PBX 订阅服务到期时间。
extensionCapacity	Long	云 PBX 的分机数量。
concurrentCallCapacity	Long	云 PBX 的通话并发数。
recordingStatus	String	云 PBX 的通话录音功能启用状态： `Enabled`：启用 `Disabled`：禁用
recordingCapacity	Long	云 PBX 的通话录音分钟数。
region	String	云 PBX 所在区域。
url	String	云 PBX 的 URL。
type	String	云 PBX 的类型。 `Trial`：试用 `Commercial`：商用
expirationDate	Long	云 PBX 的过期时间。
allowRunAfterExpirationDate	Boolean	云 PBX 到达过期时间后是否仍然可用。 `true`：PBX 仍然可用。 `false`：PBX 不可用。
version	String	云 PBX 的固件版本。
group	String	云 PBX 所在的分组。
creator	Object <Creator_Info>	云 PBX 创建者信息。
creatorRole	String	云 PBX 创建者的角色： `My Colleague`：我的同事 `Hosting User`：托管用户 `Super Administrator`：超级管理员
createTime	Long	云 PBX 创建的时间。
initialStartUpTime	Long	云 PBX 首次启动的时间。
upgradeInPbx	String	是否启用 PBX 端的固件升级功能。 `Enabled`：启用 `Disabled`：禁用
im	String	是否启用 PBX 的聊天 (IM) 功能。 `Enabled`：启用 `Disabled`：禁用
passwordlessLogin	String	是否允许免密登录 PBX。 `Enabled`：启用 `Disabled`：禁用
allowSuperiorPasswordlessLogin	String	是否允许你的上级账号从他的星纵统一管理平台上免密登录此 PBX。 `Enabled`：启用 `Disabled`：禁用
provisioningViaTemplate	String	是否允许使用模板配置此 PBX。 `Enabled`：启用 `Disabled`：禁用
lastUsedTemplate	String	最近一次使用的配置模板。
lastUsedTime	Long	最近一次使用此模板配置 PBX 的时间。
activeCalls	String	PBX 上的当前通话数量。
usedExtensions	String	PBX 上已创建的分机数量。
usedRecording	String	PBX 上已使用的录音分钟数 (单位：分钟)。
lastBackupTime	Long	最近一次在星纵统一管理平台上通过任务备份此 PBX 的时间。

Creator_Info


参数	类型	说明
firstName	String	名称。
lastName	String	姓氏。
email	String	邮箱。

示例

请求示例

查询指定云 PBX (ID：7738) 的信息。

GET /dm/open_api/v1/cloud_pbx/instances/7738 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0Mzk2OTF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQxNDkxLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI4OTVmM2I4ZC1iYjE5LTQ5Y2ItODE5NC01ZmUxYTNiMTgyNzAiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.nlO7AEithe4a-nAfPSAJv74wnJ0x-oH4jVChniV1Lmk

响应示例

HTTP/1.1 200 OK
{
  "data": {
            "cloudPbxId": 7738,
            "pbxStatus": "Running",
            "activationStatus": "Activated",
            "name": "Yeastar P-Series Cloud PBX2",
            "sn": "3658B431119XXXXX",
            "plan": "Ultimate Plan",
            "planExpirationDate": 1638427632,
            "extensionCapacity": 15,
            "concurrentCallCapacity": 15,
            "recordingStatus": "Enabled",
            "recordingCapacity": 500,
            "region": "China(GuangDong)",
            "url": "cloud2.example.yeastarcloud.com",
            "type": "Commercial",
            "expirationDate": 1638427632,  
            "allowRunAfterExpirationDate": false,
            "version": "84.8.0.25",
            "creator": 
                 {
                   "firstName": "Jane",
                   "lastName": "Smith",
                   "email": "jane@example.com"
                  },
             "creatorRole": "Hosting User",
             "createTime": 1635749236,
             "initialStartUpTime": 1635749236，
             "upgradeInPbx": "Enabled",
             "im": "Enabled",
             "passwordlessLogin": "Disabled",
             "allowSuperiorPasswordlessLogin": "Disabled",
             "provisioningViaTemplate": "Enabled",
             "lastUsedTemplate": "PCE-Provision-Template",
             "lastUsedTime": 1680138886,
             "activeCalls": "10",
             "usedExtensions": "10",
             "usedRecording": "150",
             "lastBackupTime": 1729786748
            },
  "requestId": "814bc5a4d2f281cd70a77534b4ccf48f",
  "status": "Success",
  "time": 1664440292
}