更新云 PBX 的信息

更新指定云 PBX 的名称或功能设置。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
name 是 String PBX 名称。
upgradeInPbx 是 String 是否允许从 PBX 端升级固件。
取值范围：
  • Enabled：启用
  • Disabled：禁用
im 是 String 是否启用 PBX 的聊天 (IM) 功能。
注： 可应用此设置的 P 系列云 PBX 固件版本为 84.12.0.32 或更高。
取值范围：
  • Enabled：启用
  • Disabled：禁用
passwordlessLogin 是 String 是否允许免密登录云 PBX。
取值范围：
  • Enabled：启用
  • Disabled：禁用
allowSuperiorPasswordlessLogin 是 String 是否允许你的上级账号从他的星纵统一管理平台上免密登录此云 PBX。
注： 此参数的设置仅在 passwordlessLogin 设置为 Enabled 时生效。
取值范围：
  • Enabled：启用
  • Disabled：禁用
provisioningViaTemplate 否 String 是否允许使用模板配置云 PBX。
取值范围：
  • Enabled：启用
  • Disabled：禁用

响应参数

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

示例

请求示例

禁用云 PBX (ID: 42100) 的免密登录功能。
PUT /dm/open_api/v1/cloud_pbx/instances/42100 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MTY5MjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTE4NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI1NmZhYTE0Ni0wZjUyLTRhYjEtYjkyNy1jNDZiMjRkNjc1MTYiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.jOfSRWoL0lXUd3_xRsVpvymkqu7FuLyrAGIIoNbsh_U
Content-Type: application/json
{
   "name": "Yeastar P-Series Cloud PBX",
   "upgradeInPbx": "Enabled", 
   "im": "Enabled",
   "passwordlessLogin": "Disabled",
   "allowSuperiorPasswordlessLogin": "Disabled",
   "provisioningViaTemplate": "Enabled"
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "fe23cdd17f7de47f9ec9b78aa72253e6",
  "status": "Success",
  "time": 1664518676
}