查询所有云 PBX

查询创建的所有云 PBX 的信息。

请求 URL

GET {base_url}/dm/open_api/v2/cloud_pbx/instances

请求参数

请求头


参数	是否必填	类型	说明
Authorization	是	String	在请求头中传递访问 Token。格式：Bearer `{access_token}`。

查询参数

表 1.
参数	是否必填	类型	说明
pageSize	否	Integer	定义每页显示几项查询结果。默认值：10 最大值：50
pageNumber	否	Integer	定义显示第几个页面。默认值：1
sort	否	String	定义排序字段。可在排序字段中填入 `cloudPbxId` 或 `createTime`，对查询结果进行排序。示例： `cloudPbxId`：查询结果根据云 PBX 的 ID 升序排序。 `-cloudPbxId`：查询结果根据云 PBX 的 ID 降序排序。注：如果不传递此参数，则默认根据云 PBX 的创建时间进行排序。
search	否	String	搜索关键字。注：如果不传递此参数，则会查询并返回所有云 PBX 信息。

响应参数


参数	类型	说明
data	Object <Details>	详情。
requestId	String	请求 ID，作为该请求的唯一标识，用于快速定位请求。
status	String	请求结果。 `Success`：请求成功。 `Failed`：请求失败。
time	Long	请求响应的时间。注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见将时间戳转换为日期和时间。

Details


参数	类型	说明
pageSize	Integer	每页显示几项查询结果。
pageNumber	Integer	当前显示第几页。
total	Integer	云 PBX 总数量。
list	Array <PBX_Info>	云 PBX 信息列表。

PBX_Info


参数	类型	说明
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`：旗舰版
planExpirationDate	Long	云 PBX 订阅服务到期时间。
extensionCapacity	Long	云 PBX 的分机数量。
concurrentCallCapacity	Long	云 PBX 的通话并发数。
recordingStatus	String	云 PBX 的通话录音功能启用状态： `Enabled`：启用 `Disabled`：禁用
recordingCapacity	Long	云 PBX 的通话录音分钟数。
transcriptionCapacity	Long	云 PBX 的 AI 语音转写分钟数。
transcriptionCapacityPlan	Long	云 PBX 订阅服务中包含的 AI 语音转写分钟数。注：企业版包含 120 分钟，而旗舰版包含 240 分钟。
transcriptionCapacityAddon	Long	除 PBX 订阅服务中包含的语音转写分钟数外，额外为 PBX 购买的分钟数。
usedTranscription	Long	云 PBX 已使用的 AI 语音转写分钟数。
region	String	云 PBX 所在区域。
url	String	云 PBX 的 URL。
type	String	云 PBX 的类型。 `Trial`：试用 `Commercial`：商用
expirationDate	Long	云 PBX 的过期时间。
allowRunAfterExpirationDate	Boolean	云 PBX 到达过期时间后是否仍然可用。 `true`：PBX 仍然可用。 `false`：PBX 不可用。
pbxApi	String	PBX 是否启用了 API 功能。 `Enabled`：启用 `Disabled`：禁用
version	String	云 PBX 的固件版本。
group	String	云 PBX 所在的分组。
creator	Object <Creator_Info>	云 PBX 创建者信息。
createTime	Long	云 PBX 创建的时间。
initialStartUpTime	Long	云 PBX 首次启动的时间。
upgradeInPbx	String	是否启用 PBX 端的固件升级功能。 `Enabled`：启用 `Disabled`：禁用
im	String	是否启用 PBX 的聊天 (IM) 功能。 `Enabled`：启用 `Disabled`：禁用
passwordlessLogin	String	是否允许免密登录 PBX。 `Enabled`：启用 `Disabled`：禁用
allowSuperiorPasswordlessLogin	String	是否允许你的上级账号从他的Yeastar 统一管理平台上免密登录此 PBX。 `Enabled`：启用 `Disabled`：禁用
provisioningViaTemplate	String	是否允许使用模板配置此 PBX。 `Enabled`：启用 `Disabled`：禁用
lastUsedTemplate	String	最近一次使用的配置模板。
lastUsedTime	Long	最近一次使用此模板配置 PBX 的时间。
activeCalls	String	PBX 上的当前通话数量。
usedExtensions	String	PBX 上已创建的分机数量。
usedRecording	String	PBX 上已使用的录音分钟数 (单位：分钟)。
lastBackupTime	Long	最近一次在Yeastar 统一管理平台上通过任务备份此 PBX 的时间。
autoActivated	Boolean	PBX 是否通过 API 自动激活。 `true`：PBX 已通过 API 自动激活并完成初始化配置。 `false`：PBX 已手动激活并通过安装向导页面完成初始化配置；或 PBX 尚未被激活。
recordingExpireDate	Long	额外分配给 PBX 的录音分钟数的到期时间 (即超出 500分钟免费录音分钟数外的部分)。
trunkConfigurationAccess	String	是否允许 PBX 用户是否在 PBX 上添加或导入中继。 `Enabled`：启用 `Disabled`：禁用
cloudPbxPeakInfoDTO	Object<Peak_Info>	最近两个月内的资源历史使用情况。

Creator_Info

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

Peak_Info


参数	类型	说明
mobilePeak	String	每月 Linkus 手机端的注册峰值。
pcPeak	String	每月 Linkus 桌面端的注册峰值。
padPeak	String	每月 Linkus 平板端的注册峰值。
sipPeak	String	每月 SIP 终端的注册峰值。
webPeak	String	每月 Linkus 网页端的注册峰值。
activeCallsPeak	String	每月通话并发峰值。
monthlyRecording	String	每月使用的录音分钟数。

示例

请求示例

查询所有云 PBX：

每页显示 2 条记录。
显示第 1 页。
查询结果根据云 PBX ID 升序排序。

GET /dm/open_api/v2/cloud_pbx/instances?pageSize=2&pageNumber=1&sort=cloudPbxId HTTP/1.1
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "total": 30,
        "list": [
                  {
                     "cloudPbxId": 7715,
                     "pbxStatus": "Stopped",
                     "activationStatus": "Unactivated",
                     "name": "Yeastar P-Series Cloud PBX1",
                     "sn": "3658B431119XXXXX",
                     "plan": "Enterprise Plan",
                     "planExpirationDate": 1667035676,
                     "extensionCapacity": 10,
                     "concurrentCallCapacity": 5,
                     "recordingStatus": "Enabled",
                     "recordingCapacity": 500,
                     "transcriptionCapacity":120,
                     "transcriptionCapacityPlan":120,
                     "transcriptionCapacityAddon":0,
                     "usedTranscription":0,
                     "region": "China(GuangDong)",
                     "url": "cloud.example.yeastarcloud.com",
                     "type": "Commercial",
                     "pbxApi": "Enabled",
                     "version": "84.8.0.25",
                     "group": "commercial PCE",
                     "creator": 
                                 {
                                    "firstName": "Wayne",
                                    "lastName": "William",
                                    "email": "wayne@example.com"
                                 },
                    
                      "createTime": 1635737324,
                      "initialStartUpTime": 1671158324,
                      "upgradeInPbx": "Enabled",
                      "im": "Disabled",
                      "passwordlessLogin": "Disabled",
                      "provisioningViaTemplate": "Disabled",
                      "activeCalls": "2",
                      "usedExtensions": "5",
                      "usedRecording": "50",
                      "lastBackupTime": 1729786748,
                      "autoActivated": false,
                      "recordingExpireDate": 1787031505,

                     "cloudPbxPeakInfoDTO": {
                         "mobilePeak": "-/-",
                         "pcPeak": "-/-",
                         "padPeak": "-/-",
                         "sipPeak": "-/-",
                         "webPeak": "-/-",
                         "activeCallsPeak": "-/-",
                         "monthlyRecording": "-/-"
                }
                    },
                   {
                      "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,
                     "transcriptionCapacity":240,
                     "transcriptionCapacityPlan":240,
                     "transcriptionCapacityAddon":0,
                     "usedTranscription":0,
                     "region": "China(GuangDong)",
                     "url": "cloud2.example.yeastarcloud.com",
                     "type": "Commercial",
                     "expirationDate": 1638427632,
                     "allowRunAfterExpirationDate": false,
                     "pbxApi": "Enabled",
                     "version": "84.21.0.66",
                     "group": "commercial PCE",
                     "creator": 
                                  {
                                    "firstName": "Jane",
                                    "lastName": "Smith",
                                    "email": "jane@example.com"
                                 },
               
                "createTime": 1635749236,
                "initialStartUpTime": 1635749236,
                "upgradeInPbx": "Enabled",
                "im": "Enabled",
                "passwordlessLogin": "Disabled",
                "allowSuperiorPasswordlessLogin": "no",
                "provisioningViaTemplate": "Enabled",
                "lastUsedTemplate": "PCE-Provision-Template",
                "lastUsedTime": 1680138886,
                "activeCalls": "10",
                "usedExtensions": "10",
                "usedRecording": "150",
                "lastBackupTime": 1729786748,
                "autoActivated": false,
                "recordingExpireDate": 1787031505,

                "trunkConfigurationAccess": "Enabled",
                "cloudPbxPeakInfoDTO": {
                    "mobilePeak": "5/-",
                    "pcPeak": "6/-",
                    "padPeak": "3/-",
                    "sipPeak": "3/-",
                    "webPeak": "6/-",
                    "activeCallsPeak": "16/12",
                    "monthlyRecording": "0/-"
                }
            }
        ]
    },
    "requestId": "5ed01d8b-44f2-44a7-a868-2c7ba3a090d4",
    "status": "Success",
    "time": 1639012740
}