跳到主要内容

获取用户列表​

简要描述​

  • 获取已注册用户列表。

请求方式​

  • post

请求 URL​

  • {API_ADDRESS}/user/get_users
header 名示例值选填类型说明
operationID1646445464564必填stringoperationID 用于全局链路追踪
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例​

{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}
字段名选填类型说明
pagination必填object分页参数结构体
pagination.pageNumber必填int当前页码，从 1 开始
pagination.showNumber必填int当前页请求数量

成功返回示例​

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 47,
    "users": [
      {
        "userID": "1154602570",
        "nickname": "Gordon",
        "faceURL": "http://123.321.1.1:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer.base.open%2Fcache%2Ff3a37e95-6479-48f4-b13d-d38ce9515869%2Fed34c96d017a57eae7f3c8509546bf1c.gif",
        "ex": "",
        "createTime": 0,
        "appMangerLevel": 18,
        "globalRecvMsgOpt": 0
      },
      {
        "userID": "1192927498",
        "nickname": "Blooming",
        "faceURL": "",
        "ex": "",
        "createTime": 1688381391965,
        "appMangerLevel": 18,
        "globalRecvMsgOpt": 0
      }
    ]
  }
}

成功返回示例的参数说明​

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象，具体结构见下方
totalint用户总数
usersarray用户信息列表

失败返回示例​

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明​

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息