get_users
Description
- Retrieves a list of registered users.
Request Method
POST
Request URL
{API_ADDRESS}/user/get_users
Header
Header Name | Example Value | Required | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global traceability, suggested as a unique timestamp per request |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field Name | Required | Type | Description |
---|---|---|---|
pagination | Required | object | Pagination structure |
pagination.pageNumber | Required | int | Current page number, starting from 1 |
pagination.showNumber | Required | int | Number of items per page |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 47,
"users": [
{
"userID": "1154602570",
"nickname": "Gordon",
"faceURL": "http://123.321.1.1: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
}
]
}
}
Success Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if successful |
errDlt | string | Detailed error information, empty if successful |
data | object | General data object, structure described below |
total | int | Total number of users |
users | array | List of user information |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code; refer to global error code documentation |
errMsg | string | Brief error message |
errDlt | string | Detailed error information |