在线调试
删除好友
更新时间: 2024/09/24 16:49:13
该接口可以在用户的好友列表中删除指定好友。该删除为双向操作,在用户的好友列表中删除后,同时会从对方的好友列表中被删除。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
DELETE https://open.yunxinapi.com/im/v2/friends/:{account_id}
请求头参数
请求 Header 的参数说明请参考 请求 Header。
请求路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
account_id |
String | 是 | 发起删除好友的账号 ID。 |
请求查询参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
friend_account_id |
String | 是 | 需要删除的好友账号 ID。 |
delete_alias |
Boolean | 否 | 是否删除好友的备注信息。默认为 false,不删除。 |
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
参数名称 | 类型 | 说明 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
102404 | 用户不存在 | account not exist |
104404 | 好友不存在 | friend not exist |
104449 | 好友操作频率超限 | friend operation rate limit exceeded |
500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?