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

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/friends/:{account_id}

Header

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

路径参数

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

查询参数

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

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
friend_account_id	String	好友的云信账号。	否
alias	String	好友的备注名。	否
extension	String	扩展字段，客户端和服务端均可读写。	否
server_extension	String	服务端扩展字段，客户端只读，仅服务器可修改 预留给开发者的扩展字段，建议封装成 JSON 格式。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "friend_account_id": "accid1",
        "alias": "name",
        "extension": "string",
        "server_extension": "string"
    }
}

错误码

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