Skip to main content

Get Designated Group Member

Brief Description

  • Get detailed information about designated group members.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/get_group_members_info
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"groupID": "324253771",
"userIDs": ["7009965934"]
}
Field NameOptionalTypeDescription
groupIDRequiredstringGroup ID
userIDsRequiredarrayGroup member ID list

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"members": [
{
"groupID": "xadxwr24",
"userID": "199975690",
"roleLevel": 2,
"joinTime": 1679656402380,
"nickname": "Jason",
"faceURL": "ic_avatar_05",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "openIMAdmin",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "openIMAdmin"
},
{
"groupID": "xadxwr24",
"userID": "1910095287",
"roleLevel": 1,
"joinTime": 1679656402380,
"nickname": "2234",
"faceURL": "",
"appMangerLevel": 0,
"joinSource": 2,
"operatorUserID": "openIMAdmin",
"ex": "",
"muteEndTime": 0,
"inviterUserID": "openIMAdmin"
}
]
}
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below
membersarrayGroup member info list

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message