- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
功能说明
删除好友，支持单向删除好友和双向删除好友。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/sns/friend_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com孟买： adminapiind.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/sns/friend_delete | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
单向删除好友
{"From_Account":"id","To_Account":["id1","id2","id3"],"DeleteType":"Delete_Type_Single"}
双向删除好友
{"From_Account":"id","To_Account":["id1","id2","id3"],"DeleteType":"Delete_Type_Both"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
From_Account | String | 必填 | 需要删除该 UserID 的好友 |
To_Account | Array | 必填 | 待删除的好友的 UserID 列表，单次请求的 To_Account 数不得超过1000 |
DeleteType | String | 选填 | 删除模式，详情可参见 删除好友 |
应答包体示例
{"ResultItem":[{"To_Account":"id1","ResultCode":0,"ResultInfo":""},{"To_Account":"id2","ResultCode":0,"ResultInfo":""},{"To_Account":"id3","ResultCode":0,"ResultInfo":""}],"ActionStatus":"OK","ErrorCode":0,"ErrorInfo":"0","ErrorDisplay":""}
应答包字段说明
字段 | 类型 | 说明 |
ResultItem | Array | 批量删除好友的结果对象数组 |
To_Account | String | 请求删除的好友的 UserID |
ResultCode | Integer | To_Account 的处理结果，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明 |
ResultInfo | String | To_Account 的错误描述信息，成功时该字段为空 |
ActionStatus | String | 请求包的处理结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明 |
ErrorInfo | String | 详细错误信息 |
ErrorDisplay | String | 详细的客户端展示信息 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 描述 |
30001 | 请求参数错误，请根据错误描述检查请求参数 |
30002 | SDKAppID 不匹配 |
30003 | 请求的用户账号不存在 |
30004 | 请求需要 App 管理员权限 |
30006 | 服务器内部错误，请重试 |
30007 | 网络超时，请稍后重试 |
30008 | 并发写导致写冲突，建议使用批量方式 |
31704 | 与请求删除的账号之间不存在好友关系 |
31707 | 删除好友请求被安全策略打击，请勿频繁发起删除好友请求 |
接口调试工具
参考
添加好友（v4/sns/friend_add）
导入好友（v4/sns/friend_import）
更新好友（v4/sns/friend_update）
删除所有好友（v4/sns/friend_delete_all）
校验好友（v4/sns/friend_check）
拉取好友（v4/sns/friend_get）
拉取指定好友（v4/sns/friend_get_list）
可能触发的回调
删除好友之后回调
是
否
本页内容是否解决了您的问题？