Skip to main content

get_self_friend_apply_list

Brief Description

  • As the initiator, retrieve the list of friend requests sent by this user to other users.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/friend/get_self_friend_apply_list
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Request Sample Parameters

{
"userID": "11111111",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field NameOptionalTypeDescription
userIDRequiredstringUser ID
paginationRequiredobjectPagination parameter structure
pagination.pageNumberRequiredintCurrent page number, starting from 1
pagination.showNumberRequiredintNumber of requests on the current page

Successful Return Sample

{
"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": ""
},
{
"fromUserID": "11111111",
"fromNickname": "yourNickname",
"fromFaceURL": "yourFaceURL",
"toUserID": "11111113",
"toNickname": "yourNickname",
"toFaceURL": "yourFaceURL",
"handleResult": 1,
"reqMsg": "hello!",
"createTime": 1688460586632,
"handlerUserID": "openIMAdmin",
"handleMsg": "agree",
"handleTime": 1688460590618,
"ex": ""
}
],
"total": 2
}
}

Successful Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message, empty when no error
dataobjectGeneral data object, specific structure shown below
friendRequestsarrayList of Friend Requests
totalintTotal number of friend requests initiated by the user

Failed Return Sample

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

Failed Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, refer to the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message