logo
当前页

批量删除好友


描述

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

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

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

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

iOSAndroidmacOSWindowsWeb
friendListChangedonFriendListChangedfriendListChangedonFriendListChangedfriendListChanged
小程序Flutteruni-appReact Native
friendListChangedonFriendListChangedfriendListChangedfriendListChanged

接口原型

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

请求参数

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

参数类型是否必选描述
FromUserIdString为此 UserId(已注册)删除好友。
UserIdsArray of String删除目标好友列表。默认数量上限为 20。
DeleteTypeNumber删除类型:
  • 0:双向删除。
  • 1:单向删除。
说明

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

请求示例

  • 请求地址 URL:
Untitled
https://zim-api.zego.im/?Action=DeleteFriends
&<公共请求参数>
1
Copied!
  • 请求消息体:
Untitled
{
    "FromUserId": "zego_user",
    "UserIds": [
        "user_id1",
        "user_id2"
    ],
    "DeleteType": 1
}
1
Copied!

响应参数

参数类型描述
CodeNumber返回码。
说明
当您发起请求同时删除多名好友时:
  • 如果成功删除 1 名或更多好友,Code 都会返回 0。此时请参考 ErrorList 中的具体信息,确认操作结果。
  • 如果全部目标好友删除失败,Code 会返回相关返回码,具体请参考全局返回码
MessageString请求结果的说明信息。
RequestIdString请求 ID。
ErrorListArray of Object

失败信息列表。

  • Code 为 0:

    • ErrorList 为空,成功删除全部目标好友。
    • ErrorList 不为空,表示删除部分好友失败,请参考 SubCode 处理。

  • Code 不为 0:

    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示全部指定好友删除失败。

└UserIDString无法删除 UserID 为此的好友。
└SubCodeNumber具体失败返回码。

响应示例

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

返回码

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

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

Previous

批量发送好友申请

Next

删除所有好友