Skip to main content

get_groups_info

Brief Description

  • Retrieve detailed information of the specified group.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/get_groups_info
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Sample Request Parameters

{
"groupIDs": ["2137448827", "2559217223"]
}
Field NameOptionalTypeDescription
groupIDsRequiredarrayList of group IDs

Sample Success Response

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"groupInfos": [
//... (rest of the group data is trimmed for brevity)
]
}
}

Parameters Explanation for Success Response

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty if no error
errDlterrDltDetailed error message, empty if no error
dataobjectGeneral data object, see detailed structure below
groupInfosarrayGroup information list

Sample Failure Response

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

Parameters Explanation for Failure Response

Parameter NameTypeDescription
errCodeintError code, see global error code documentation for details
errMsgstringBrief error message
errDlterrDltDetailed error message