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

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2.1/friends

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

查询参数

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

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否还有更多数据。	否
next_token	String	分页标识符。	否
- items	Array of objects	返回的好友列表信息。	否
friend_account_id	String	好友的 IM 账号。	否
alias	String	好友的备注名。	否
extension	String	扩展字段，客户端和服务端均可读写。	否
customer_extension	String	客户端自定义扩展字段，仅服务器 API 可以设置，SDK 仅负责透传，不解析内容。	否

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "items": [
      {
        "alias": "alias_update",
        "extension": "extension_update",
        "friend_account_id": "yx5",
        "customer_extension": "customer_extension_update"
      }, {
        "friend_account_id": "mgd0"
      }
    ],
    "has_more": false
  }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
104449	好友操作频率超限	friend operation rate limit exceeded
500	服务器内部错误	internal server error