get_users
Brief Description
- Retrieve a list of registered users.
Request Method
post
Request URL
{API_ADDRESS}/user/get_users
Header
Header Name | Sample Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Mandatory | string | operationID for global link tracing |
token | eyJhbxxxx3Xs | Mandatory | string | Admin token |
Request Parameter Example
{
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
pagination | Mandatory | object | Pagination parameter structure |
pagination.pageNumber | Mandatory | int | Current page number, starting from 1 |
pagination.showNumber | Mandatory | int | Number 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 Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error message, empty if no error |
data | object | Generic data object, see structure below |
total | int | Total number of users |
users | array | List 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 Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to global error code document for details |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |