Skip to content

搜索用户完整信息 ​

1. 接口定位 ​

  • 接口名称: 搜索用户完整信息
  • 所属域: admin/user(adminx)
  • 业务目标: 管理员分页搜索用户完整信息,支持默认稳定排序和可选白名单排序

2. 请求定义 ​

  • Method: POST
  • Path: /adminx/user/search/full
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 必填,需要通过 Header token 传入有效的管理员登录令牌
  • 幂等性: 幂等(只读操作)

3. 请求参数 ​

Header 参数 ​

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

Body 参数 ​

字段必填类型说明
keyword否string可为空;按用户 ID、账号、手机号精确匹配,或按昵称、邮箱前缀匹配
userID否string用户 ID 精确匹配
phoneNumber否string手机号精确匹配
account否string账号精确匹配
email否string邮箱精确匹配
genders否int32性别过滤:0 全部,1 男,2 女
pagination是RequestPagination分页参数(pageNumber、showNumber)
normal否int32用户范围:0 所有用户,1 普通用户(排除封禁账号);其他值当前按全部处理
sortField否string排序字段,见下方白名单;不传时使用默认排序
sortOrder否int32排序方向:1 升序,-1 降序;不传或传 0 时使用默认排序

分页参数结构 ​

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

排序白名单 ​

字段示例实际排序字段说明
userID / user_iduser_id用户 ID
accountaccount账号
nicknamenickname昵称
gendergender性别
levellevel等级
registerType / register_typeregister_type注册类型
createTime / create_timecreate_time创建时间
changeTime / change_timechange_time修改时间
birthTime / birth_timebirth_time生日时间
lastActiveTime / last_active_timelast_active_time最后活跃时间

字段约束 ​

  • pagination 不能为空,且 pageNumber/showNumber 必须大于 0。
  • keyword 为空时不增加关键字过滤;非空时按用户 ID、账号、手机号精确匹配,或按昵称、邮箱前缀匹配(忽略大小写)。
  • keyword 命中的五个字段之间按 OR 组合;userID、phoneNumber、account、email 独立参数仍分别精确匹配,并与 keyword、其他筛选条件按 AND 组合。
  • 不支持通过 areaCode 匹配手机号。
  • sortField 仅支持白名单字段,非法值会返回参数错误。
  • sortOrder 仅支持 1 或 -1,非法值会返回参数错误。
  • 默认排序为 create_time desc,并使用 user_id 作为稳定次序字段。

4. 响应结构 ​

通用响应包裹 ​

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataany业务数据

data 字段结构 ​

字段类型说明
totaluint32查询结果总数
usersarray用户完整信息列表

users 元素字段 ​

字段类型说明
baseobject通用用户完整信息(与 openim.chat.common.UserFullInfo 一致)
extraobject管理员侧扩展字段

users.base 字段 ​

字段类型说明
userIDstring用户 ID
passwordstring保留字段,始终为空字符串
accountstring账号
phoneNumberstring手机号
areaCodestring区号
emailstring邮箱
nicknamestring昵称
faceURLstring头像 URL
genderint32性别
levelint32等级
birthint64生日时间,Unix 毫秒时间戳
allowAddFriendint32是否允许加好友
allowBeepint32是否允许消息提示音
allowVibrationint32是否允许震动
globalRecvMsgOptint32全局消息接收设置
registerTypeint32注册类型
exstringopen-im-server 用户扩展字段(原样返回)
isBlockedbool是否封禁账号
isOfficialbool是否官方账号
lastActiveTimeint64最后活跃时间,Unix 毫秒时间戳

users.extra 字段 ​

字段类型说明
registerTimeint64注册时间,Unix 毫秒时间戳
lastLoginTimeint64最后登录时间,Unix 毫秒时间戳(无登录记录时为 0)
lastLoginIpstring最后登录 IP(无登录记录时为空字符串)
lastActiveTimeint64最后活跃时间,Unix 毫秒时间戳(优先在线活跃;无记录时回退 DAU 最后活跃日期 00:00,再回退最后登录时间,仍无则为 0)

5. 业务规则 ​

  • keyword 支持用户 ID、账号、手机号精确匹配,以及昵称、邮箱前缀匹配,五个字段按 OR 组合;昵称和邮箱匹配忽略大小写。
  • userID、phoneNumber、account、email 独立参数分别精确匹配;它们与 keyword 及其他过滤条件按 AND 组合。
  • 支持按单个性别过滤:0 全部,1 男,2 女。
  • normal=1 时会排除封禁账号;其他值按全部用户处理。
  • 排序默认按 create_time desc 返回,并用 user_id 保证同一排序键下的稳定分页。
  • 响应包含 users.extra.registerTime(用户注册时间)、users.extra.lastLoginTime(最后登录时间;若无登录记录则为 0)、users.extra.lastLoginIp(最后登录 IP;若无登录记录则为空字符串)和 users.extra.lastActiveTime(最后活跃时间,兼容字段)。
  • 响应包含 users.base.isBlocked,用于标识用户是否处于封禁状态。
  • 响应包含 users.base.isOfficial 与 users.base.lastActiveTime,作为用户主信息字段返回。
  • 响应包含 users.base.ex,来源于 open-im-server 用户扩展字段,按字符串原样透传。
  • lastActiveTime 展示值优先在线活跃时间,缺失时先回退 DAU 最后活跃日期,再回退最后登录时间。
  • sortField=lastActiveTime/last_active_time 时基于用户表落库字段排序;该字段按用户维度每小时最多写库一次,属于最终一致视图。

6. 错误码与失败场景 ​

错误码场景典型报错
1001pagination 为空pagination is empty
1001pageNumber 为空或非法pagination invalid
1001showNumber 为空或非法pagination invalid
1001sortField 非白名单unsupported sortField
1001sortOrder 非法sortOrder must be 1 or -1

7. 示例 ​

fetch 请求示例 ​

javascript
fetch("http://localhost:10009/adminx/user/search/full", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440109",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    keyword: "李",
    genders: 1,
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
    normal: 0,
    sortField: "create_time",
    sortOrder: -1,
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON) ​

json
{
  "keyword": "李",
  "genders": 1,
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  },
  "normal": 0,
  "sortField": "create_time",
  "sortOrder": -1
}

成功响应示例 ​

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "users": [
      {
        "base": {
          "userID": "user001",
          "password": "",
          "account": "lili",
          "phoneNumber": "13800138000",
          "areaCode": "+86",
          "email": "lili@example.com",
          "nickname": "老李",
          "faceURL": "https://example.com/avatar1.jpg",
          "gender": 1,
          "level": 5,
          "birth": 1704067200000,
          "allowAddFriend": 1,
          "allowBeep": 1,
          "allowVibration": 1,
          "globalRecvMsgOpt": 0,
          "registerType": 1,
          "ex": "{\"isOfficial\":true,\"badge\":\"vip\"}",
          "isBlocked": false,
          "isOfficial": true,
          "lastActiveTime": 1735598400000
        },
        "extra": {
          "registerTime": 1704067200000,
          "lastLoginTime": 1735512000000,
          "lastLoginIp": "203.0.113.10",
          "lastActiveTime": 1735598400000
        }
      }
    ]
  }
}

失败响应示例 ​

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "unsupported sortField"
}

8. 时序流程 ​

  1. 验证管理员 token。
  2. 校验 pagination。
  3. 解析并校验排序字段和排序方向。
  4. 根据 normal 计算是否排除封禁账号。
  5. 按 keyword、独立精确搜索字段、性别和排序条件查询用户列表。
  6. 返回总数和分页后的用户完整信息。

9. 变更记录 ​

  • 2026-05-30: 新增 adminx 用户完整信息搜索接口,支持默认稳定排序和白名单排序,作为管理员侧用户列表查询入口。
  • 2026-08-31: 响应新增 users.extra.lastActiveTime 字段,用于展示用户最后活跃时间。
  • 2026-09-03: 支持 lastActiveTime 排序;最后活跃时间落库采用 LAST_ACTIVE_AT -> DAU_DAY -> LAST_LOGIN -> NONE,并按用户 1 小时节流写库。
  • 2026-09-27: 响应新增 users.extra.isOfficial 字段,用于标识官方账号。
  • 2026-09-27: 响应新增 users.base.ex 字段,原样返回 open-im-server 用户扩展字段。
  • 2026-09-27: 响应新增 users.base.isBlocked 字段,用于标识封禁状态。
  • 2026-09-27: users.extra.isOfficial 迁移为 users.base.isOfficial;users.base 新增 lastActiveTime,users.extra.lastActiveTime 保留兼容。
  • 2026-10-13: keyword 支持用户 ID、账号、手机号精确匹配及昵称、邮箱前缀匹配;新增独立精确搜索字段。