获取已注册用户 ID 列表

简要描述

• 获取已注册的用户 ID 列表。

请求方式

• post

请求 URL

• {API_ADDRESS}/user/get_all_users_uid

Header

header 名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议使用时间戳，在每个请求中独立
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}

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

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 0,
    "userIDs": [
      "openIM123456",
      "openIM654321",
      "openIMAdmin",
      "kernaltestuid2",
      "alantestuid2"
    ]
  }
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简要信息，为空
errDlt	errDlt	错误详细信息，为空
data	object	通用数据对象，具体结构见下方
total	int	用户总数
userIDs	array	用户 ID 列表

失败返回示例

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

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息