扩容云 PBX

为指定云 PBX 扩容。

请求 URL

PUT {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/capacity

请求参数

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

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
extensionCapacity 是 Long 云 PBX 的分机数量。
concurrentCallCapacity 是 Long 云 PBX 的并发数。
recordingStatus 是 String 是否启用云 PBX 的通话录音功能。
取值范围：
  • Enabled：启用
  • Disabled：禁用
recordingCapacity 是 Long 通话录音分钟数。

响应参数

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

示例

请求示例

将云 PBX (ID：42100) 录音分钟数扩容到 600 分钟。
PUT /dm/open_api/v1/cloud_pbx/instances/42100/capacity HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MTY5MjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTE4NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI1NmZhYTE0Ni0wZjUyLTRhYjEtYjkyNy1jNDZiMjRkNjc1MTYiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.jOfSRWoL0lXUd3_xRsVpvymkqu7FuLyrAGIIoNbsh_U
Content-Type: application/json
{
    "extensionCapacity":30,
    "concurrentCallCapacity":15,
    "recordingStatus":"Enabled",
    "recordingCapacity":600
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "8b4491aab168766a3c44bc3683bc75c2",
  "status": "Success",
  "time": 1664517231
}