搜索违禁词白名单

1. 接口定位

• 接口名称: 搜索违禁词白名单
• 所属域: admin/sensitive-word
• 业务目标: 分页检索用户/群白名单

2. 请求定义

• Method: POST
• Path: /adminx/sensitive_word/whitelist/search
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等；同条件分页查询返回稳定结果

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
targetType	否	string	user 或 group，空表示全部
keyword	否	string	匹配 targetID
status	否	int32	0 全部，1 启用，2 禁用
pagination	是	object	分页参数

字段约束

• 协议校验要求 pagination 非空。
• targetType 为空表示不过滤；非空时仅允许 user/group。
• status 仅允许 0/1/2。

4. 响应 data

通用响应包裹

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

data 字段

字段	类型	说明
total	uint32	总条数
items	array<object>	当前页白名单项

items 元素字段

字段	类型	说明
targetType	string	目标类型
targetID	string	目标 ID
enabled	bool	是否启用
creator	string	创建人
createTime	int64	创建时间(ms)
updateTime	int64	更新时间(ms)

5. 业务规则

• keyword 按 targetID 模糊匹配。
• 时间字段为毫秒时间戳。

6. 错误码与失败场景

错误码	场景	典型报错
1001	pagination 为空	pagination is empty
1001	targetType 非法	targetType must be user or group
1001	status 非法	status must be 0/1/2
-	数据库搜索失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10011/adminx/sensitive_word/whitelist/search", {
  method: "POST",
  headers: {
    operationID: "sensitive-whitelist-search-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    targetType: "user",
    keyword: "u_",
    status: 1,
    pagination: { pageNumber: 1, showNumber: 20 },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "targetType": "user",
  "keyword": "u_",
  "status": 1,
  "pagination": { "pageNumber": 1, "showNumber": 20 }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "items": [
      {
        "targetType": "user",
        "targetID": "u_1001",
        "enabled": true,
        "creator": "admin_001",
        "createTime": 1760000000000,
        "updateTime": 1760000000000
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "pagination is empty"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 pagination、targetType、status。
3. 执行分页查询并组装 total + items。
4. 返回统一成功响应。

9. 变更记录

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