Skip to main content

get_users

Brief Description

  • Retrieve a list of registered users.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/user/get_users
Header NameSample ValueOptionalTypeDescription
operationID1646445464564MandatorystringoperationID for global link tracing
tokeneyJhbxxxx3XsMandatorystringAdmin token

Request Parameter Example

{
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field NameOptionalTypeDescription
paginationMandatoryobjectPagination parameter structure
pagination.pageNumberMandatoryintCurrent page number, starting from 1
pagination.showNumberMandatoryintNumber of requests on the current page

Successful Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 47,
"users": [
{
"userID": "1154602570",
"nickname": "Gordon",
"faceURL": "http://203.56.175.233: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
}
]
}
}

Successful Response Parameters Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if no error
errDlterrDltDetailed error message, empty if no error
dataobjectGeneric data object, see structure below
totalintTotal number of users
usersarrayList of User Information

Failed Response Example

{
"errCode": 500,
"errMsg": "ServerInternalError",
"errDlt": "runtime error: invalid memory address or nil pointer dereference"
}

Failed Response Parameters Explanation

Parameter NameTypeDescription
errCodeintError code, refer to global error code document for details
errMsgstringBrief error message
errDlterrDltDetailed error message