跳到主要内容

获取第三方渠道同玩好友列表

POST /v2/friend/friend_list​

此接口使游戏能够从第三方渠道检索玩家的好友名单。

注意

此接口目前只支持 Facebook、Garena、QQ、Steam、WeChat 和 VK。在多渠道包场景下，由于渠道方限制，Facebook 和 WeChat 渠道仅能拉取到同一 app ID 的同玩好友。

关于调用频率限制，请参见 接口限制。

请求参数​

关于接口调用的查询参数，请参见 查询参数。

参数类型描述备注
openidstringPlayer Network SDK 用户唯一标识必填
tokenstringPlayer Network SDK 用户登录态必填

请求示例​

curl -sS -X POST -H 'Content-Type: application/json' 'https://test.intlgame.com/v2/friend/friend_list?channelid=21&gameid=11&os=5&source=0&ts=1590485133&sdk_version=2.0&sig=b0131f8a844dcdb1044a87ea2a6d5f0d' -d '{"token":"b71de93cc578b442f129e2aa445655828386fec9","openid":"5642128712278250897"}'

返回参数​

参数类型描述
retint返回码
0: 正确
其他: 失败
msgstring结果的详细信息
listsarray同一第三方渠道上的好友列表
is_lostint当is_lost的值=1时，获得的数据被降级。不要缓存数据。
如果有缓存的数据，先使用缓存的数据。只有在没有缓存数据时才使用当前数据。
seqstring请求 URL 携带的序列号

Lists 说明​

lists {
    string openid;           // 用户标识 ID
    string user_name;        // 用户名
    uint gender;             // 性别. 1: 男; 2: 女; 0: 未设置
    string picture_url;      // 头像网址
}

返回示例​

{
  "ret": 0,
  "msg": "SUCCESS",
  "is_lost": 0,
  "lists": [
    {
      "openid": "9556832059718695202"
    },
    {
      "openid": "6045537030682645917"
    },
    {
      "openid": "8620320801333649204"
    },
    {
      "openid": "18062972584926121462"
    }
  ],
  "seq": "1590992804-0266701833-005087-0000003295"
}

接口限制​

此接口返回的列表为第三方渠道接口返回的好友列表过滤而来，调用方需要关注渠道限制，例如：

  • Facebook：每小时请求限制为=日活*200。
    更多信息，请参见 流量限制。
  • VK：
    • 每个客户端每秒最多可以向 API 方法发送3个请求;
    • 服务器请求的最大数量取决于应用程序的用户数量：
      • 如果应用程序的用户数少于1万，则每秒限制5个请求；
      • 用户数多达10万，则每秒8个请求；
      • 用户数多达100万，则每秒限制20个请求；
      • 用户数超过100万，则每秒限制35个请求；
    • 更多信息，请参见 API Requests。
  • Steam：每个应用每天调用 Steam Web API 十万(100,000) 次
    更多信息，请参见 Steam Web API Terms of Use。

因为渠道限制可能随时变更，因此具体限制以对应渠道官方文档为准。

最后于 更新