搜索邀请码

1. 接口定位

• 接口名称: 搜索邀请码
• 所属域: admin/invitation-code
• 业务目标: 按状态、邀请码、使用人和关键字分页检索邀请码记录，并补充使用人的公开资料

2. 请求定义

• Method: POST
• Path: /invitation_code/search
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
status	是	int32	邀请码状态筛选
userIDs	否	array<string>	按使用人 user_id 精确筛选
codes	否	array<string>	按邀请码精确筛选
keyword	否	string	对 invitation_code 和 user_id 做不区分大小写模糊匹配
pagination	是	object	分页参数

status 取值

值	含义	实际过滤条件
0	全部	不按使用状态过滤
1	已使用	user_id != ""
2	未使用	user_id == ""

pagination 字段

字段	必填	类型	说明
pageNumber	是	int32	页码，从 1 开始
showNumber	是	int32	每页条数，大于 0

4. 响应结构

通用响应包裹

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

data 字段

字段	类型	说明
total	uint32	命中的邀请码总数
list	array<object>	当前页邀请码记录列表

list 元素字段

字段	类型	说明
invitationCode	string	邀请码
createTime	int64	创建时间，Unix 毫秒时间戳
usedUserID	string	使用该邀请码的用户 ID；未使用时为空字符串
usedUser	object	使用人的公开资料；未使用时通常为空

5. 业务规则

• 仅管理员可以调用。
• 搜索流程先在本地邀请码表中按条件分页检索，再汇总非空 usedUserID 到 chat 服务批量补 UserPublicInfo。
• userIDs 和 codes 是精确匹配过滤条件。
• keyword 会对 invitation_code 与 user_id 同时执行 MongoDB $regex 模糊匹配，忽略大小写。
• 当 status 与 userIDs 同时传入时，后者会覆盖 user_id 维度的状态过滤条件；这是当前数据库过滤逻辑的真实行为。

6. 错误码与失败场景

错误码	场景	典型报错
1001	status 非 0/1/2	state invalid
1001	pagination 为空	pagination is empty
1001	pageNumber < 1	pageNumber is invalid
1001	showNumber < 1	showNumber is invalid
-	数据库搜索失败	由数据库层返回原始错误
-	补使用人公开资料失败	由 chat 服务链路返回

7. 示例

fetch 请求示例

fetch("http://localhost:10009/invitation_code/search", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440404",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    status: 1,
    keyword: "welcome",
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "status": 1,
  "keyword": "welcome",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "list": [
      {
        "invitationCode": "WELCOME2026",
        "createTime": 1767225600000,
        "usedUserID": "1000001234",
        "usedUser": {
          "userID": "1000001234",
          "nickname": "alice",
          "faceURL": "https://example.com/avatar.png"
        }
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "state invalid"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 status 与分页参数。
3. 在邀请码表中按 status、userIDs、codes、keyword 分页搜索。
4. 提取当前页中的非空 usedUserID，调用 chat 服务批量获取用户公开资料。
5. 组装 total + list 并返回。

9. 变更记录

• 2026-03-31: 首版发布，基于邀请码搜索、状态过滤和使用人资料补充逻辑补全文档。