该接口可以为两个账号建立好友关系，支持直接添加好友（不需要好友验证）以及申请添加好友（需要好友验证）两种方式。

功能描述

每个账号的好友数默认上限为 3000。如果已经是好友关系，接口不会报错，也不会下发通知。

若仍需要扩展每个账号的好友数，可以在 网易云信控制台 首页的 应用管理 中选择应用，进入 应用配置 > IM 即时通讯 > 功能配置 > 全局配置 > 好友数 进行配置。

调用频率

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

请求 URL

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

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

请求头参数

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

请求查询参数

参数名称	类型	是否必选	描述
type	Integer	否	申请添加好友的验证方式： 1（默认）：直接添加，无需好友验证。 2：需要对方验证通过。

请求体参数

参数名称	类型	是否必选	说明	默认值
account_id	String	是	发起好友申请的 IM 账号 ID。	-
friend_account_id	String	是	需要添加为好友的 IM 账号 ID。	-
alias	String	否	好友的备注名，长度上限 128 位字符。	-
extension	String	否	扩展字段，客户端和服务端均可读写，长度上限 256 位字符。对应客户端对外字段 serverExtension。	-
customer_extension	String	否	客户端自定义扩展字段，仅服务器 API 可以设置，SDK 仅负责透传，不解析内容。	-
postscript	String	否	需要对方验证的添加好友方式（type=2）时的显示文案，该字段需要过反垃圾审核。	默认文案为 申请加好友

请求体示例

JSON{
    "account_id": "apiv2test",
    "friend_account_id": "apiv2test2",
    "alias": "zhangsan",
    "message": "申请加好友",
    "extension": "string",
    "customer_extension": "string"
}

响应信息

响应头参数

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

响应体参数

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

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "alias": "alias",
    "extension": "extension",
    "friend_account_id": "yx4",
    "customer_extension": "customer_extension"
  }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
104405	好友已存在	friend already exist
104429	不允许对自己进行好友操作	self friend operation not allowed
104435	好友数量超出上限	friend accounts limit exceeded
104301	对方好友数量超出上限	peer friend limit exceeded
104449	好友操作频率超限	friend operation rate limit exceeded
104451	好友申请信息未通过反垃圾审核	friend hit antispam
500	服务器内部错误	internal server error