Skip to main content

好友列表

1. 前言：​

2. 交互时序图：​

3. 请求场景：​

获取好友列表

4. 接口要求：​

使用来伊份openapi加密协议进行加密请求

5. 接口标准​

5.1 基本信息​

描述值
服务名称im-app-api
URL测试环境：https://openapi.test.laiyifen.com/im-app-api/friends
生产环境：https://openapi.laiyifen.com/im-app-api/friends
认证方式令牌
请求方式HTTP(GET)
功能描述(适用场景)获取好友列表

5.2 请求头公共参数 （Header）​

参数名字参数类型是否必须说明
X-Co-ClientString是客户端Id（来伊份提供）
X-Co-SignString是签名
X-Co-TimeStampString是签名时间戳

5.3 入参 Parameters​

参数名字参数类型是否必须说明
lyfuidString是第三方应用用户授权id
pageint是分页
pageSizeint是每页条数

5.4 入参示例​

?lyfuid=302179DCC2F12D929080F6CBD9610F5C&page=1&pageSize=10

5.5 返回统一参数​

参数名字参数类型是否必须说明
codeString是返回请求业务代码
msgString是返回信息描述
dataJson是返回参数

5.6 返回参数Data​

参数名字参数类型是否必须说明
authorizationList<UserInfo>是已经授权过的好友列表
unauthorizationList<UserInfo>是未授权过的好友列表

UserInfo

参数名字参数类型是否必须说明
lyfuidString是授权过的数组中返回第三方应用用户授权id，未授权的返回加密的 id
photoUrlString是用户的头像
userNameString是用户名

5.7 返回示例​

{
  "code": "0",
  "msg": "success",
  "data": {
    "authorization": [
    ],
    "unauthorization": [
      {
        "lyfuid": "302179DCC2F12D929080F6CBD9610F5C",
        "photoUrl": "https://static4.laiyifen.com/files/guide/image/b3xxxxxxx03.jpg",
        "userName": "伊客"
      }
    ]
  }
}