API 参考
在线调试

添加好友

更新时间: 2024/07/17 16:50:28

功能描述

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

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

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

调用频率

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

URL

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

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

查询参数

参数名称 类型 是否必选 描述
type Integer 可选 申请添加好友的验证方式,1(默认):直接添加,无需好友验证;2:需要对方验证通过。

请求体参数

参数名称 类型 是否必选 描述 默认值
account_id String 必选 发起好友申请的云信账号 ID。 -
friend_account_id String 必选 需要添加为好友的云信账号 ID。 -
alias String 可选 好友的备注名,长度上限 128 位字符。 -
extension String 可选 扩展字段,客户端和服务端均可读写,长度上限 256 位字符。 -
server_extension String 可选 服务端扩展字段,客户端只读,仅服务器可修改,长度上限 256 位字符。 -
message String 可选 需要对方验证的添加好友方式(type=2)时的显示文案,该字段需要过反垃圾审核。 默认文案为"申请加好友"

请求体示例

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

响应

Header

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

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

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

错误码

错误码 错误码描述 错误信息示例
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
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • URL
  • Header
  • 查询参数
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码