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

调用频率

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

请求信息

请求 URL

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

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

请求头参数

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

请求路径参数

参数名称	类型	是否必选	描述
account_id	String	是	发起查询操作的账号 ID。

查询参数

参数名称	类型	是否必选	描述
friend_account_id	String	是	需要查询的好友账号 ID。

响应信息

响应头参数

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

响应体参数

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

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "alias": "alias_update",
    "extension": "extension_update",
    "friend_account_id": "yx5",
    "customer_extension": "customer_extension_update"
  }
}

错误码

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

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