全群禁言
1. 接口定位
- 接口名称: 全群禁言
- 所属域: group
- 业务目标: 将指定群设置为全员禁言状态
2. 请求定义
- Method:
POST - Path:
/group/mute_group - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,需要通过 Header
token传入有效令牌 - 幂等性: 幂等(重复调用后群状态保持为禁言)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 登录令牌 |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| groupID | 是 | string | 目标群组 ID |
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | any | 业务数据 |
data 字段结构
- 成功时为空对象或
null。
5. 业务规则
- 需要具备群管理权限(群主/管理员,或应用管理账号)。
- 接口会将群状态更新为“Muted”。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1002 | 无权限执行禁言 | NoPermissionError |
| 1201 | 群组不存在 | GroupIDNotFoundError |
| 500 | 服务内部错误 | ServerInternalError |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10002/group/mute_group", {
method: "POST",
headers: {
operationID: "1e4a3790-49ef-4700-9f14-b5091fc8f561",
token: "<your-token>",
"Content-Type": "application/json",
},
body: JSON.stringify({
groupID: "group_001",
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"groupID": "group_001"
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}8. 时序流程
- 校验调用者是否具备群管理权限。
- 更新群状态为全群禁言。
- 发送群状态变更通知。
9. 变更记录
- 2026-04-09: 首版补充文档发布。