文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 用户相关
  • 删除所有好友

删除所有好友

更新时间:2024-03-06 17:43

描述

调用此接口,可为用户单向或双向删除全部好友数据。

以用户 A、B 举例说明单向删除和双向删除:

  • 单向删除:当用户 A 单向删除了用户 B,用户 B 不再是用户 A 的好友、用户 A 仍为用户 B 的好友。
  • 双向删除:当用户 A 双向删除了用户 B,彼此都不再是对方的好友。

为用户删除好友成功后,相关用户的客户端将通过以下 ZIM SDK 的回调接口接收好友列表更新的通知:

iOS Android macOS Windows Web
friendListChanged
onFriendListChanged
friendListChanged
onFriendListChanged
friendListChanged
小程序 Flutter uni-app React Native
friendListChanged
onFriendListChanged
friendListChanged
friendListChanged

接口原型

  • 请求方法:GET
  • 请求地址:https://zim-api.zego.im/?Action=DeleteAllFriends
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。

参数 类型 是否必选 描述
FromUserId
String
是
为此 UserId(已注册)删除全部好友。
DeleteType
Number
是
删除类型:

  • 0:双向删除。
  • 1:单向删除。

FromUserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

请求示例

https://zim-api.zego.im/?Action=DeletedAllFriends
&FromUserId=zego_user&DeleteType=1
&<公共请求参数>

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
请求结果的说明信息。
RequestId
String
请求 ID。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
}

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。

返回码 描述 处理建议
660000001
业务类通用错误。
请重试,或联系 ZEGO 技术支持。
660000002
输入参数错误。
请检查输入的参数。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈