删除分组

删除一个或多个分组。

请求 URL

DELETE {base_url}/dm/open_api/v1/groups

请求参数

请求头
参数 是否必填 类型 说明
Authorization String 在请求头中传递访问 Token。

格式:Bearer {access_token}

请求体
参数 是否必填 类型 说明
ids Array<Integer> 要删除的分组的 ID。
注:
  • 可使用 查询所有分组 查询分组 ID。
  • 使用半角逗号 , 分隔多个 ID。例如,[1001,1005]

响应参数

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

示例

请求示例

删除一个分组 (ID:19997)。

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

{
    "ids":[19997]
}

响应示例

HTTP/1.1 200 OK
{
    "requestId": "0bcb13a8e0150ae727eb03327ded528a",
    "status": "Success",
    "time": 1775718353
}