Get Group Member List
Brief Description
- Retrieves the list of members in a group.
Request Method
post
Request URL
{API_ADDRESS}/group/get_group_member_list
Header
| Header Name | Example Value | Optional | Type | Description |
|---|---|---|---|---|
| operationID | 1646445464564 | Required | string | Used for global trace tracking. It is recommended to use a timestamp, unique for each request |
| token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"groupID": "2559217223",
"keyword": "userID",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
| Field Name | Optional | Type | Description |
|---|---|---|---|
| groupID | Required | string | Group ID |
| keyword | Optional | string | The userID or nickname of a group member; returns paginated data if not provided |
| pagination | Required | object | Pagination parameter structure |
| pagination.pageNumber | Required | int | Current page number, starting from 1 |
| pagination.showNumber | Required | int | Number of items requested per page |
Success 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"
},
{
"groupID": "2559217223",
"userID": "3645617224",
"roleLevel": 60,
"joinTime": 1687762198048,
"nickname": "Huo",
"faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687846002615.jpg",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "4771680259",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "4771680259"
},
{
"groupID": "2559217223",
"userID": "3791793226",
"roleLevel": 20,
"joinTime": 1687760824107,
"nickname": "Wo",
"faceURL": "",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "4771680259",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "4771680259"
},
{
"groupID": "2559217223",
"userID": "4771680259",
"roleLevel": 100,
"joinTime": 1687760824107,
"nickname": "Lumia",
"faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687330764676.jpg",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "4771680259",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "4771680259"
},
{
"groupID": "2559217223",
"userID": "7117248489",
"roleLevel": 20,
"joinTime": 1687762198048,
"nickname": "Hello",
"faceURL": "",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "4771680259",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "4771680259"
}
]
}
}
Success Response Parameters Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, 0 indicates success |
| errMsg | string | Brief error message, empty if none |
| errDlt | errDlt | Detailed error information, empty if none |
| data | object | General data object, see structure below |
| total | int | Total number of group members |
| members | array | List of Group Member Information |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameters Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, refer to global error code documentation |
| errMsg | string | Brief error message |
| errDlt | errDlt | Detailed error information |