添加建群白名单
1. 接口定位
- 接口名称: 添加建群白名单
- 所属域: admin/group
- 业务目标: 将指定用户加入建群白名单
2. 请求定义
- Method:
POST - Path:
/adminx/group/create_permission/add - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 非幂等
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| userIDs | 是 | array<string> | 待加入白名单的用户 ID 列表 |
| reason | 否 | string | 加入白名单原因 |
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 成功时返回空对象。
5. 业务规则
- 所有
userID必须能查到用户资料,否则返回user id not found。 - 已存在于白名单中的用户不能重复添加。
- 写入时会记录操作人
opUserID和创建时间。 reason原样落库,不做额外枚举或长度规范化。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | Header 缺少 operationID | header must have operationID |
| 1002 | 用户已在白名单中 | user already in group create whitelist |
| 1001 | 某些用户不存在 | user id not found |
| - | 缺少管理员 token | 由管理员鉴权链路返回 |
| - | 用户资料查询失败 | 由用户资料查询链路返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10011/adminx/group/create_permission/add", {
method: "POST",
headers: {
operationID: "group-create-permission-add-001",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
userIDs: ["user_001", "user_002"],
reason: "运营活动白名单",
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"userIDs": ["user_001", "user_002"],
"reason": "运营活动白名单"
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1002,
"errMsg": "DuplicateKey",
"errDlt": "user already in group create whitelist"
}8. 时序流程
- 中间件校验管理员 token。
- RPC 层批量查询用户公开资料,确认所有
userID都存在。 - 检查是否已有用户存在于建群白名单中。
- 记录
opUserID、reason、创建时间并批量写入。
9. 变更记录
- 2026-04-06: 补全文档结构,修正真实服务前缀为
/adminx。