API 参考
在线调试

分页查询好友列表

更新时间: 2024/07/17 16:50:28

该接口可以分页查询指定账号的所有好友信息,包括好友备注名、扩展信息、是否为双向好友等。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

GET https://open.yunxinapi.com/im/v2/friends

请求 Header 的参数说明请参见请求 Header

查询参数

参数名称 类型 是否必选 描述
account_id String 必选 发起分页查询操作的云信账号 ID。
page_token String 可选 分页标识符(标识查询位置索引的字符串值),如果为空,则默认从第一条记录开始查询。对应上次分页查询返回的 next_token 值。
limit Integer 可选 单页查询的数量上限,默认和最大值都为 100。

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": true,
        "next_token": "asdfrqwewqe",
        "items": [
            {
                "friend_account_id": "accid1",
                "alias": "name",
                "extension": "string",
                "server_extension": "string"
            },
            {
                "friend_account_id": "accid2",
                "alias": "name",
                "extension": "string",
                "server_extension": "string"
            }
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
104449 好友操作频率超限 friend operation rate limit exceeded
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码