Skip to main content

get_joined_group_list

Brief Description

  • Retrieve the groups a specific user has joined.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/group/get_joined_group_list
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Sample Request Parameters

{
"fromUserID": "9906953281",
"pagination": {
"showNumber": 10,
"pageNumber": 1
}
}
Field NameOptionalTypeDescription
fromUserIDRequiredstringUser ID
paginationRequiredobjectPagination parameter structure
pagination.showNumberRequiredintCurrent page number, starting from 1
pagination.pageNumberRequiredintNumber of requests on the current page

Sample Success Response

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 3,
"groups": [
//... (rest of the groups 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
totalintTotal number of joined groups
groupsarrayGroup 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