新增违禁词白名单

1. 接口定位

• 接口名称: 新增违禁词白名单
• 所属域: admin/sensitive-word
• 业务目标: 配置用户/群白名单，命中白名单时跳过违禁词拦截

2. 请求定义

• Method: POST
• Path: /adminx/sensitive_word/whitelist/add
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 非幂等；重复条目依赖数据库唯一索引控制

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
items	是	array<object>	白名单条目

items 元素字段：

字段	必填	类型	说明
targetType	是	string	user 或 group
targetID	是	string	用户 ID 或群 ID
enabled	是	bool	是否启用

字段约束

• 协议校验要求 items 非空。
• targetType 仅允许 user/group。
• 元素为 null 或 targetID 为空时会被忽略。
• 同一次请求内按 targetType + targetID 去重。

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

• 本接口成功时返回空对象（无业务字段）。

5. 业务规则

• 白名单条目写入时会记录 creator/createTime/updateTime。
• enabled=true 的条目在消息发送前检查阶段可直接放行。

6. 错误码与失败场景

错误码	场景	典型报错
1001	items 为空	items is empty
1001	targetType 非法	targetType must be user or group
1001	全部条目均无效	no valid whitelist items
-	数据库唯一索引冲突	由数据库层返回原始错误
-	数据库写入失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10011/adminx/sensitive_word/whitelist/add", {
  method: "POST",
  headers: {
    operationID: "sensitive-whitelist-add-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    items: [
      { targetType: "user", targetID: "u_1001", enabled: true },
      { targetType: "group", targetID: "g_1002", enabled: true },
    ],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "items": [
    { "targetType": "user", "targetID": "u_1001", "enabled": true },
    { "targetType": "group", "targetID": "g_1002", "enabled": true }
  ]
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "targetType must be user or group"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 items 非空，校验每个条目的 targetType。
3. 跳过空目标并按 targetType + targetID 去重。
4. 补充创建人和时间后批量写库。
5. 返回统一成功响应。

9. 变更记录

• 2026-07-14: 文档重构为标准 admin API 模板，补齐 Header、响应结构、失败示例与时序流程。