跳到主要内容

获取已注册用户 ID 列表

简要描述

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

请求方式

  • post

请求 URL

  • {API_ADDRESS}/user/get_all_users_uid
header 名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪,建议使用时间戳,在每个请求中独立
tokeneyJhbxxxx3Xs必填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"
]
}
}

成功返回示例的参数说明

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

失败返回示例

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

失败返回示例的参数说明

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