Skip to main content

get_friend_list

Description

  • Retrieve the friend list of a specific user.

Request Method

  • post

Request URL

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

Request Body Example

{
"userID": "11111111",
"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": {
"friendsInfo": [
{
"ownerUserID": "11111111",
"remark": "",
"createTime": 1688458955,
"friendUser": {
"userID": "11111112",
"nickname": "alantestuid3",
"faceURL": "1111111",
"ex": "",
"createTime": 0,
"appMangerLevel": 0,
"globalRecvMsgOpt": 0
},
"addSource": 2,
"operatorUserID": "11111111",
"ex": ""
},
{
"ownerUserID": "11111111",
"remark": "",
"createTime": 1688459860,
"friendUser": {
"userID": "11111113",
"nickname": "yourNickname",
"faceURL": "yourFaceURL",
"ex": "",
"createTime": 0,
"appMangerLevel": 0,
"globalRecvMsgOpt": 0
},
"addSource": 2,
"operatorUserID": "11111111",
"ex": ""
}
],
"total": 2
}
}

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
friendsInfoarrayList of friend information
totalintTotal number of friends

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