get_group_member_list
Brief Description
- Retrieve the list of group members.
Request Method
post
Request URL
http://x.x.x.x:10002/group/get_group_member_list
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID used for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameter Example
{
"groupID": "2559217223",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
groupID | Required | string | Group ID |
pagination | Required | object | Structure for pagination parameters |
pagination.pageNumber | Required | int | Current page number, starting from 1 |
pagination.showNumber | Required | int | Number of requests per page |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 5,
"members": [
{
"groupID": "2559217223",
"userID": "3034068043",
"roleLevel": 20,
"joinTime": 1687762198048,
"nickname": "OK",
"faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687330588901.jpg",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "4771680259",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "4771680259"
},
// ... [other members]
]
}
}
Successful Response Parameter Description
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty when no error |
errDlt | errDlt | Detailed error message |
data | object | Generic data object, specific structure seen below |
total | int | Total number of group members |
members | array | List of group member information |
Failed Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failed Response Parameter Description
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to the global error code documentation for specifics |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |