该接口可以同意或拒绝好友请求。

调用频率

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

请求信息

请求 URL

POST https://open.yunxinapi.com/im/v2/friends/actions/handle_friend_addition

请求头参数

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

查询参数

参数名称	类型	是否必选	描述
type	Integer	否	好友申请的验证方式。3（默认）：同意；4：拒绝。

请求体参数

参数名称	类型	是否必选	描述
account_id	String	是	发起同意或拒绝操作的账号 ID。
friend_account_id	String	是	需要添加为好友的账号 ID。
alias	String	否	好友的备注名，长度上限 128 位字符。
extension	String	否	扩展字段，客户端和服务端均可读写，长度上限 256 位字符。对应客户端对外字段 serverExtension。
customer_extension	String	否	客户端自定义扩展字段，仅服务器 API 可以设置，SDK 仅负责透传，不解析内容。
postscript	String	否	操作附言。

请求体示例

JSON{
    "account_id": "apiv2test",
    "friend_account_id": "apiv2test2",
    "alias": 1,
    "postscript": "zhangsan",
    "customer_extension": "string"
}

响应信息

响应头参数

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

响应体参数

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

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "friend_account_id": "accid2",
        "alias": "name",
        "extension": "string",
        "customer_extension": "string"
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
104404	好友不存在	friend not exist
104429	不能添加自己为好友	self friend operation not allowed
104435	自己的好友列表长度超出最大限制	account_id friend limit 3000
104301	对方的好友列表长度超出最大限制	friend_account_id peer friend limit 3000
104449	对单个好友的操作过于频繁，请稍后再试	friend operation need retry
104451	好友申请信息命中反垃圾	friend hit antispam
500	服务器内部错误	internal server error