删除所有好友
GET
https://zim-api.zego.im/
调用此接口,可为用户单向或双向删除全部好友数据。
以用户 A、B 举例说明单向删除和双向删除:
- 单向删除:当用户 A 单向删除了用户 B,用户 B 不再是用户 A 的好友、用户 A 仍为用户 B 的好友。
- 双向删除:当用户 A 双向删除了用户 B,彼此都不再是对方的好友。
为用户删除好友成功后,相关用户的客户端将通过以下 ZIM SDK 的回调接口接收好友列表更新的通知:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| friendListChanged | onFriendListChanged | friendListChanged | onFriendListChanged |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| friendListChanged | friendListChanged | onFriendListChanged | friendListChanged |
| uni-app | uni-app x | HarmonyOS |
|---|---|
| friendListChanged | friendListChanged |
说明
参数 FromUserId 仅支持数字,英文字符和
'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。说明
调用频率限制:20 次/秒。
Request
Query Parameters
- 0:双向删除。
- 1:单向删除。
Action string必填
可选值: [DeleteAllFriends]
接口原型参数
https://zim-api.zego.im/?Action=DeleteAllFriends
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
FromUserId string必填
可选值: <= 32 characters
为此 UserId(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)删除全部好友。
DeleteType number必填
可选值: [0, 1]
删除类型:
Responses
- 200
OK
- application/json

