更新分组

更新分组信息，包括分组名称和组内的 P-Series Cloud PBX 列表。

请求 URL

PUT {base_url}/dm/open_api/v1/groups/{id}

请求参数

路径参数
参数 是否必填 类型 说明
id 是 Integer 分组 ID。
注： 可使用 查询所有分组 查询分组 ID。
请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
groupName 是 String 分组名称。
注： 长度不可超过 127 个字符。
pbxIdList 否 Array<Integer> 要添加到分组中的 P 系列云 PBX 的 ID。
注：
  • 该参数执行全量替换，只有指定的 ID 会保留在组中。如果不传该参数，则分组中现有云 PBX 实例都将从分组中移除。
  • 可使用 查询所有云 PBX 查询云 PBX ID。
  • 使用半角逗号 , 分隔多个 ID。例如，[389283,96569]。

响应参数

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

示例

请求示例

将一台云 PBX (ID：25369) 添加到某分组中 (ID：20039)。

PUT /dm/open_api/v1/groups/20039 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json

{
    "groupName":"API-Created Group 1",   
    "pbxIdList":[276931,300123,25369]  // 保留组内现有 PBX 的 ID (276931&300123)
}

响应示例

HTTP/1.1 200 OK
{
    "requestId": "f5285074a23520f2dd765a8411a874e0",
    "status": "Success",
    "time": 1775726933
}