获取用户好友列表

获取指定用户好友列表。

开通服务

调用此接口前，您须在控制台开通信息托管服务。

请求方法

POST： https://数据中心域名/friend/get.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数	类型	必传	说明
userId	String	是	操作用户id
pageToken	String	否	遍历查询pageToken信息,第一次可不传,第二次需要使用第一次调用返回的pageToken
size	String	否	每次获取的数量,默认50,最大支持100
order	String	否	查询排序: 0.按照添加好友时间正序(默认)；1.按照添加好友时间倒序

请求示例

POST /friend/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=id1&pageToken=XM2AKD1B2AH&size=60&order=1

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值	返回类型	说明
code	Number	返回码，200 为正常。
pageToken	String	下一次遍历查询pageToken信息
totalCount	Number	好友总数
friendList	JsonArray	好友对象列表
friendList[i].userId	String	好友id
friendList[i].name	String	好友名称
friendList[i].remarkName	String	好友备注名
friendList[i].friendExtProfile	String	好友的自定义扩展属性
friendList[i].time	Number	添加好友时间戳(毫秒)

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 200,
    "pageToken":"XM2AKD1B2AH",
    "totalCount":200,
    "friendList":[
        {
          "userId":"id2",
          "name":"zhangsan",
          "remarkName":"zs",
          "friendExtProfile":"{\"ext_key1\":\"value1\",\"ext_key2\":\"value2\"}",
          "time":1727712000000
        },
        {
          "userId":"id3",
          "name":"lisi",
          "remarkName":"ls",
          "friendExtProfile":"{\"ext_key1\":\"value1\"}",
          "time":1727712000001
        }
    ]
}