解散群组
1. 接口定位
- 接口名称: 解散群组
- 所属域: group
- 业务目标: 将群组标记为已解散,或直接删除群成员关系
2. 请求定义
- Method:
POST - Path:
/group/dismiss_group - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,需要通过 Header
token传入有效令牌 - 幂等性: 条件幂等(同状态重复解散会返回“已解散”错误)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 登录令牌 |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| groupID | 是 | string | 目标群组 ID |
| deleteMember | 否 | bool | 是否直接删除成员数据;默认 false |
| sendMessage | 否 | bool | deleteMember=false 时是否发送解散通知 |
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | any | 业务数据 |
data 字段结构
- 成功时为空对象或
null。
5. 业务规则
- 非应用管理员时,仅群主可解散群。
- 当
deleteMember=false且群已是解散状态时,会返回“已解散”错误。 - 成功后会触发群解散通知与 webhook(取决于配置与参数)。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1002 | 非群主且非应用管理员 | NoPermissionError |
| 1201 | 群组不存在 | GroupIDNotFoundError |
| 1204 | 群已解散(重复解散) | DismissedAlreadyError |
| 500 | 服务内部错误 | ServerInternalError |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10002/group/dismiss_group", {
method: "POST",
headers: {
operationID: "f95f3295-445a-44f8-b7f9-92f0a30f77a1",
token: "<your-token>",
"Content-Type": "application/json",
},
body: JSON.stringify({
groupID: "group_001",
deleteMember: false,
sendMessage: true
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"groupID": "group_001",
"deleteMember": false,
"sendMessage": true
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}8. 时序流程
- 校验调用者权限(群主或应用管理员)。
- 执行群解散/成员清理。
- 发送解散通知并触发回调。
9. 变更记录
- 2026-04-09: 首版补充文档发布。