禁言群成员
1. 接口定位
- 接口名称: 禁言群成员
- 所属域: group
- 业务目标: 对指定群成员设置禁言时长(秒)
2. 请求定义
- Method:
POST - Path:
/group/mute_group_member - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,需要通过 Header
token传入有效令牌 - 幂等性: 非严格幂等(重复调用会刷新禁言截止时间)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 登录令牌 |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| groupID | 是 | string | 群组 ID |
| userID | 是 | string | 被禁言用户 ID |
| mutedSeconds | 是 | uint32 | 禁言时长(秒) |
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | any | 业务数据 |
data 字段结构
- 成功时为空对象或
null。
5. 业务规则
- 应用管理员可直接操作;普通群权限遵循角色约束。
- 群主不可被禁言。
- 管理员仅可禁言普通成员,不能禁言其他管理员或群主。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1002 | 越权禁言(如普通成员操作) | NoPermissionError |
| 1201 | 群组不存在 | GroupIDNotFoundError |
| 500 | 服务内部错误 | ServerInternalError |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10002/group/mute_group_member", {
method: "POST",
headers: {
operationID: "45f4f77e-0f84-42c4-9a86-7ef7a072fdce",
token: "<your-token>",
"Content-Type": "application/json",
},
body: JSON.stringify({
groupID: "group_001",
userID: "u_1002",
mutedSeconds: 600
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"groupID": "group_001",
"userID": "u_1002",
"mutedSeconds": 600
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}8. 时序流程
- 校验目标成员与操作者角色关系。
- 写入禁言截止时间。
- 发送禁言通知。
9. 变更记录
- 2026-04-09: 首版补充文档发布。