Skip to main content

Get Received Group Join Requests

Brief Description

  • Retrieves join requests for groups managed by a specified user.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/get_recv_group_applicationList
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": "8423809271",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field NameOptionalTypeDescription
fromUserIDRequiredstringUser ID
paginationRequiredobjectPagination parameter structure
pagination.pageNumberRequiredintCurrent page number, starting from 1
pagination.showNumberRequiredintNumber of items per page

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 1,
"groupRequests": [
{
"userInfo": {
"userID": "4356065820",
"nickname": "Tom",
"faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer.base.open%2Fcache%2Fimage_cropper_1688350826192.jpg",
"ex": ""
},
"groupInfo": {
"groupID": "1085123084",
"groupName": "Rose baby、Jack Dawson、Jacky",
"notification": "notification1",
"introduction": "",
"faceURL": "",
"ownerUserID": "8423809271",
"createTime": 1688353410770,
"memberCount": 3,
"ex": "",
"status": 0,
"creatorUserID": "8423809271",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
},
"handleResult": 1,
"reqMsg": "",
"handleMsg": "reason",
"reqTime": 1688376825952,
"handleUserID": "",
"handleTime": 0,
"ex": "",
"joinSource": 3,
"inviterUserID": ""
}
]
}
}

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 group join requests
groupRequestsarrayList of Group Join Request Objects

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