跳到主要内容

获取收到的好友申请​

简要描述​

  • 作为被添加者，获取其他用户向该用户发出的好友申请列表。

请求方式​

  • post

请求URL​

  • http://x.x.x.x:10002/friend/get_friend_apply_list
header名示例值选填类型说明
operationID1646445464564必填stringoperationID用于全局链路追踪
tokeneyJhbxxxx3Xs必填string管理员token

请求参数示例​

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

成功返回示例​

{
  "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": ""
      }
    ],
    "total": 1
  }
}

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

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

失败返回示例​

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

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

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