跳到主要内容

获取用户ID列表

简要描述

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

请求方式

  • post

请求URL

  • http://x.x.x.x:10002/user/get_all_users_uid
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": 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错误详细信息