Skip to main content

Get Group Details

Brief Description

  • Get the detailed information of designated groups, including group name, member count, etc.

Request Method

  • post

Request URL

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

Request Parameter Example

{
"groupIDs": ["2137448827", "2559217223"]
}
Field NameOptionalTypeDescription
groupIDsRequiredarrayGroup ID list

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"groupInfos": [
{
"groupID": "2559217223",
"groupName": "Group1",
"notification": "",
"introduction": "",
"faceURL": "",
"ownerUserID": "4771680259",
"createTime": 1687760824104,
"memberCount": 5,
"ex": "",
"status": 0,
"creatorUserID": "4771680259",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
},
{
"groupID": "2137448827",
"groupName": "11111",
"notification": "",
"introduction": "",
"faceURL": "",
"ownerUserID": "3517105008",
"createTime": 1687753739612,
"memberCount": 3,
"ex": "",
"status": 0,
"creatorUserID": "2699373280",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
}
]
}
}

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
groupInfosarrayGroup 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