Skip to main content

get_friend_apply_list

Description

  • Retrieve the list of friend requests received by a user.

Request Method

  • post

Request URL

  • {API_ADDRESS}/friend/get_friend_apply_list
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, recommended to use a timestamp for uniqueness in each request.
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Body Example

{
"userID": "11111112",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field NameOptionalTypeDescription
userIDRequiredstringUser ID
paginationRequiredobjectPagination details
pagination.pageNumberRequiredintCurrent page number, starts from 1
pagination.showNumberRequiredintNumber of entries per page

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"FriendRequests": [
{
"fromUserID": "11111111",
"fromNickname": "yourNickname",
"fromFaceURL": "yourFaceURL",
"toUserID": "11111112",
"toNickname": "alantestuid3",
"toFaceURL": "1111111",
"handleResult": 1,
"reqMsg": "hello!",
"createTime": 1688458858893,
"handlerUserID": "openIMAdmin",
"handleMsg": "agree",
"handleTime": 1688458955357,
"ex": ""
}
],
"total": 1
}
}

Success Response Parameters

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error message, empty if successful
dataobjectData object, see structure below
FriendRequestsarrayList of friend request information
totalintTotal number of friend requests received

Failure Response Example

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

Failure Response Parameters

Parameter NameTypeDescription
errCodeintError code, refer to the global error code documentation
errMsgstringBrief error message
errDltstringDetailed error message