提交工单
咨询集成、功能及报价等问题
调用此接口,可为用户批量单向或双向删除至多 20 名好友。如需上调(最多可为 50),请联系 ZEGO 技术支持。
以用户 A、B 举例说明单向删除和双向删除:
为用户删除好友成功后,相关用户的客户端将通过以下 ZIM SDK 的回调接口接收好友列表更新的通知:
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
小程序 | Flutter | uni-app | React Native | |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId |
String |
是 |
为此 UserId(已注册)删除好友。 |
UserIds |
Array of String |
是 |
删除目标好友列表。默认数量上限为 20。 |
DeleteType |
Number |
是 |
删除类型:
|
FromUserId 和 UserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
请求地址 URL:
https://zim-api.zego.im/?Action=DeleteFriends
&<公共请求参数>
请求消息体:
{
"FromUserId": "zego_user",
"UserIds": [
"user_id1",
"user_id2"
],
"DeleteType": 1
}
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。
当您发起请求同时删除多名好友时:
|
Message |
String |
请求结果的说明信息。 |
RequestId |
String |
请求 ID。 |
ErrorList |
Array of Object |
失败信息列表。
|
UserID |
String |
无法删除 UserID 为此的好友。 |
SubCode |
Number |
具体失败返回码。 |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"ErrorList": [
{
"UserId": "usera2",
"SubCode": 660800022
}
]
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 描述 | 处理建议 |
---|---|---|
660000002 |
输入参数错误。 |
请检查输入的参数。 |
660300005 |
调用接口的频率超出了 AppID 级别限制。 |
请稍后再试。 |
660500002 |
FromUserId 未注册。 |
请先注册 FromUserId 。 |
660800019 |
单次批量操作超过上限。 |
减少单次批量操作数量。 |
660800022 |
参数中的用户 ID 相关参数重复。 |
请删除或修改重复参数。 |
660800033 |
UserIds 中的字符串不能与 FromUserId 相同。 |
请修改 UserIds 中与 FromUserId 相同的字符串。 |
660800034 |
目标用户不是 FromUserId 的好友。 |
无需处理。 |
联系我们
文档反馈