批量删除好友

POST

https://zim-api.zego.im/

调用此接口，可为用户批量单向或双向删除至多 20 名好友。如需上调（最多可为 50），请联系 ZEGO 技术支持。

以用户 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 和 UserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册。

说明

参数 FromUserId 和 UserId 仅支持数字，英文字符和

'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'

。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [DeleteFriends]

接口原型参数

https://zim-api.zego.im/?Action=DeleteFriends

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

为此 UserId 删除好友。

UserIds string[]必填

可选值: <= 20

删除目标好友列表。默认数量上限为 20。

DeleteType number必填

可选值: [0, 1]

删除类型：

0：双向删除。
1：单向删除。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码。

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

说明

当您发起请求同时删除多名好友时：

如果成功删除 1 名或更多好友，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。

如果全部目标好友删除失败，Code 会返回相关返回码，具体请参考全局返回码。

Code / SubCode	描述	处理建议
660000002	输入参数错误。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660500002	FromUserId 未注册。	请先注册 FromUserId。
660800019	单次批量操作超过上限。	减少单次批量操作数量。
660800022	参数中的用户 ID 相关参数重复。	请删除或修改重复参数。
660800033	UserIds 中的字符串不能与 FromUserId 相同。	请修改 UserIds 中与 FromUserId 相同的字符串。
660800034	目标用户不是 FromUserId 的好友。	无需处理。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

ErrorList object[]

失败信息列表。

Code 为 0：
ErrorList 为空，成功删除全部目标好友。
ErrorList 不为空，表示删除部分好友失败，请参考 SubCode 处理。
Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示全部指定好友删除失败。

Array[

UserId string

无法删除 UserID 为此的好友。

SubCode integer

具体失败返回码，完整返回码请参考 Code 说明或者全局返回码。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "usera2",
      "SubCode": 660800022
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "usera2",
      "SubCode": 660800022
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。