即时通讯
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • Unity3D
  • uni-app
  • React Native
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 实现基本消息收发
  • 用户相关
  • 房间相关
  • 群组相关
  • 消息相关
  • 呼叫邀请
  • 会话管理
  • 缓存管理
  • 离线推送
  • 语音组件
  • 客户端 API
  • 服务端 API
  • 迁移方案
  • SDK 错误码
  • 常见问题
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 用户相关
  • 查询好友列表

查询好友列表

更新时间:2024-02-02 23:59

描述

根据用户 ID 分页拉取其好友列表,获取备注、好友关系建立时间等信息。

接口原型

  • 请求方法:GET
  • 请求地址:https://zim-api.zego.im/?Action=QueryFriendList
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
FromUserId
String
查询此 UserID(已注册)的好友列表。
Limit
Number
单次拉取多少名好友的信息。取值范围为 [0, 100]。如果不填或数值为 0、大于 100,取值为 100。
Next
Number
分页拉取标志,第一次填 0 ,之后填上一次返回的 Next 值。当返回的 Next 为 0 时,代表好友列表获取完毕。

例如,FromUserId 有 250 个好友,调用本接口查询时:

  1. 第一次调用本接口,Limit 填 100,Next 传空,查询第 1 ~ 100 名好友;返回结果中的 Next 值为 num1。
  2. 第二次调用本接口,Limit 填 100,Next 填 num1,查询第 101 ~ 200 名好友;返回结果中 Next 值为 num2。
  3. 第三次调用本接口,Limit 填 100,Next 填 num2,查询第 201 ~ 250 名好友;查询完毕,返回结果中的 Next 为 0。

请求示例

https://zim-api.zego.im/?Action=QueryFriendList
&Limit=100&Next=2&FromUserId=zego
&<公共请求参数>

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
请求结果的说明信息。
RequestId
String
请求 ID。
TotalCount
Number
当前好友总数。
Next
Number
分页拉取标志,非 0 表示还有好友的信息未返回,需要将该字段设置到请求参数 Next 中拉取更多用户的信息;为 0 表示已经返回所有用户的信息。
FriendInfos
Array of Object
好友数据列表。
UserId
String
好友的用户 ID。
UserName
String
用户名称。
Avatar
String
用户头像地址。
Wording
String
建立好友关系时的附言。
FriendAlias
String
FromUserId 对此好友的备注。
CreateTime
Number
好友关系建立时间,单位为 ms。
Attributes
Array Of Object
好友属性。
Key
String
好友属性的键。
Value
String
好友属性的值。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "TotalCount": 500,
    "Next": 1,
    "FriendInfos": [
        {
            "UserId": "UserA",
            "UserName": "UserNameA",
            "Avatar": "Avatar1",
            "Wording": "Wording1",
            "FriendAlias": "FriendAlias1",
            "CreateTime": 1698310534000,
            "Attributes": [
                {
                    "Key": "k1",
                    "Value": "Value"
                },
                {
                    "Key": "k0",
                    "Value": "Value1"
                }
            ]
        },
        {
            "UserId": "UserB",
            "UserName": "UserNameB",
            "Avatar": "Avatar2",
            "Wording": "Wording1",
            "FriendAlias": "FriendAlias2",
            "CreateTime": 1698310534000,
            "Attributes": [
                {
                    "Key": "k3",
                    "Value": "Value"
                },
                {
                    "Key": "k4",
                    "Value": "Value1"
                }
            ]
        }
    ]
}

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明 处理建议
660000001
业务类通用错误。
请重试,或联系 ZEGO 技术支持。
660000002
参数错误。
请检查请求参数。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试。
本篇目录