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
Header Name | Example Value | Required | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global traceability, suggested as a unique timestamp per request |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"userID": "11111111",
"pagination": {
"pageNumber": 1,
"showNumber": 100
}
}
Field Name | Required | Type | Description |
---|---|---|---|
userID | Required | string | User ID |
pagination | Required | object | Pagination structure |
pagination.pageNumber | Required | int | Current page number, starting from 1 |
pagination.showNumber | Required | int | Number 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
Parameter | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if successful |
errDlt | string | Detailed error information, empty if successful |
data | object | General data object, structure described below |
friendRequests | array | List of friend request information |
total | int | Total number of friend requests sent by the user |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code; refer to global error code documentation |
errMsg | string | Brief error message |
errDlt | string | Detailed error information |