提交工单
咨询集成、功能及报价等问题
调用此接口,可为用户批量拉黑至多 20 名用户,不再接收相关用户消息。如需上调,请联系 ZEGO 技术支持。
每名用户默认最多可拉黑 1000 名用户,如需上调,请联系 ZEGO 技术支持。
为用户拉黑用户成功后,此用户客户端将通过以下 ZIM SDK 的回调接口接收黑名单列表更新的通知:
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
小程序 | Flutter | uni-app | React Native | |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId |
String |
是 |
为此 UserId(已注册)拉黑用户。 |
UserIds |
Array of String |
是 |
待拉黑的用户列表。字符串默认上限为 20。每个字符串长度上限为 32 字节。 |
FromUserId 和 UserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
请求地址 URL:
https://zim-api.zego.im/?Action=AddUsersToBlacklist
&<公共请求参数>
请求消息体:
{
"FromUserId": "zego_user",
"UserIds": [
"user1",
"user2",
"user3",
"user4"
]
}
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。
当您发起请求同时拉黑多名用户时:
|
Message |
String |
请求结果的说明信息。 |
RequestId |
String |
请求 ID。 |
ErrList |
Array of Object |
失败信息列表。
|
UserID |
String |
拉黑此 UserID 失败。 |
SubCode |
Number |
具体失败返回码。 |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"ErrList": [
{
"UserId": "user1",
"SubCode": 660000002
}
]
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 描述 | 处理建议 |
---|---|---|
660000002 |
输入参数错误。 |
请检查输入的参数。 |
660300005 |
调用接口的频率超出了 AppID 级别限制。 |
请稍后再试。 |
660500002 |
FromUserId 未注册。 |
请确认该用户是否已注册:
|
6607000015 |
接口目标用户未注册。 |
请确认该用户是否已注册:
|
660800001 |
FromUserId 未注册。 |
请确认该用户是否已注册:
|
660800037 |
用户已被拉黑,无需重复操作。 |
无需处理。 |
660800038 |
不能拉黑 FromUserId 或将 FromUserId 移除黑名单。 |
请修改 UserIds 。 |
660800039 |
传入的用户列表超过限制。 |
请缩短传入的用户列表。 |
660800040 |
FromUserId 的黑名单已达上限,无法拉黑更多用户。 |
无需处理。 |
660800041 |
拉黑全部指定用户失败。 |
请参考响应参数 ErrList 的 SubCode 处理. |
联系我们
文档反馈