Skip to main content

get_self_friend_apply_list

Description

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

Request Method

  • POST

Request URL

  • {API_ADDRESS}/friend/get_self_friend_apply_list
Header NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"userID": "11111111",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field NameRequiredTypeDescription
userIDRequiredstringUser ID
paginationRequiredobjectPagination structure
pagination.pageNumberRequiredintCurrent page number, starting from 1
pagination.showNumberRequiredintNumber of items 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": ""
},
{
"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
}
}

Success Response Parameter Description

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful
dataobjectGeneral data object, structure described below
friendRequestsarrayList of friend request information
totalintTotal number of friend requests sent by the user

Failure Response Example

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

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information