跳到主要内容

获取好友列表​

简要描述​

  • 获取指定用户的好友列表。

请求方式​

  • post

请求 URL​

  • {API_ADDRESS}/friend/get_friend_list
header 名示例值选填类型说明
operationID1646445464564必填stringoperationID 用于全局链路追踪
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例​

{
  "userID": "11111111",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}
字段名选填类型说明
userID必填string用户 ID
pagination必填object分页参数结构体
pagination.pageNumber必填int当前页码，从 1 开始
pagination.showNumber必填int当前页请求数量

成功返回示例​

{
  "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
  }
}

成功返回示例的参数说明​

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象，具体结构见下方
friendsInfoarray好友信息列表
totalint返回的好友总数

失败返回示例​

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

失败返回示例的参数说明​

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息