Skip to main content

Get Joined Groups

Brief Description

  • Retrieves the groups that a specified user has joined.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/get_joined_group_list
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global trace tracking. It is recommended to use a timestamp, unique for each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"fromUserID": "9906953281",
"pagination": {
"showNumber": 10,
"pageNumber": 1
}
}
Field NameOptionalTypeDescription
fromUserIDRequiredstringUser ID
paginationRequiredobjectPagination parameter structure
pagination.showNumberRequiredintNumber of items per page
pagination.pageNumberRequiredintCurrent page number, starting from 1

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 3,
"groups": [
{
"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": ""
},
{
"groupID": "2759960147",
"groupName": "Group2",
"notification": "",
"introduction": "",
"faceURL": "",
"ownerUserID": "4771680259",
"createTime": 1688106933734,
"memberCount": 7,
"ex": "",
"status": 0,
"creatorUserID": "4771680259",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
},
{
"groupID": "3686066424",
"groupName": "Group3",
"notification": "",
"introduction": "",
"faceURL": "",
"ownerUserID": "9906953281",
"createTime": 1687933342067,
"memberCount": 3,
"ex": "",
"status": 0,
"creatorUserID": "9906953281",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
}
]
}
}

Success Response Parameters Description

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if none
errDlterrDltDetailed error information, empty if none
dataobjectGeneral data object, see structure below
totalintTotal number of joined groups
groupsarrayList of Group Information

Failure Response Example

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

Failure Response Parameters Description

Parameter NameTypeDescription
errCodeintError code, refer to global error code documentation
errMsgstringBrief error message
errDlterrDltDetailed error information