logo
即时通讯
机器人
ZIM Audio
当前页

AddUsersToBlacklist

POST

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

调用此接口,可为用户批量拉黑至多 20 名用户,不再接收相关用户消息。如需上调,请联系 ZEGO 技术支持。

每名用户默认最多可拉黑 1000 名用户,如需上调,请联系 ZEGO 技术支持。

为用户拉黑用户成功后,此用户客户端将通过以下 ZIM SDK 的回调接口接收黑名单列表更新的通知:

iOSAndroidmacOSWindows
blacklistChangedonBlacklistChangedblacklistChangedonBlacklistChanged
Web小程序FlutterReact Native
blacklistChangedblacklistChangedonBlacklistChangedblacklistChanged
uni-app | uni-app xHarmonyOS
blacklistChangedblacklistChanged
说明

参数 FromUserIdUserIds 对应的用户已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册。

说明
参数 FromUserId 和 UserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'
说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [AddUsersToBlacklist]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    为此 UserId 拉黑用户。

    UserIds string[]必填

    可选值: <= 20

    待拉黑的用户列表。字符串默认上限为 20。每个字符串长度上限为 32 字节。

Responses

OK
Schema
    Code integer

    返回码。

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

    说明

    当您发起请求同时更新多个好友属性:

    • 如果成功更新 1 个或更多属性,Code 都会返回 0。此时请参考 FailKey 中的具体信息,确认操作结果。
    • 如果全部好友属性更新失败,Code 会返回相关返回码,具体请参考 全局返回码
    Code / SubCode描述处理建议
    660000002输入参数错误。请检查输入的参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660500002FromUserId 未注册。请确认该用户是否已注册:
    确认已注册,请联系 ZEGO 技术支持排查。
    确认未注册,请注册此用户。
    6607000015接口目标用户未注册。请确认该用户是否已注册:
    确认已注册,请联系 ZEGO 技术支持排查。
    确认未注册,请注册此用户。
    660800001FromUserId 未注册。请确认该用户是否已注册:
    确认已注册,请联系 ZEGO 技术支持排查。
    确认未注册,请注册此用户。
    660800037用户已被拉黑,无需重复操作。无需处理。
    660800038不能拉黑 FromUserId 或将 FromUserId 移除黑名单。请修改 UserIds。
    660800039传入的用户列表超过限制。请缩短传入的用户列表。
    660800040FromUserId 的黑名单已达上限,无法拉黑更多用户。无需处理。
    660800041拉黑全部指定用户失败。请参考响应参数 ErrList 的 SubCode 处理.
    Message string

    请求结果的说明信息。

    RequestId string

    请求 ID。

    ErrList object[]
    • 当您发起请求同时拉黑多名用户时:
    • 如果成功拉黑 1 名或更多用户,Code 都会返回 0。此时请参考 ErrList 中的具体信息,确认操作结果。
    • 如果全部指定用户拉黑失败,Code 会返回相关返回码,具体请参考 全局返回码
  • Array[
  • UserId string

    拉黑此 UserID 失败。

    SubCode number

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

  • ]

上一篇

更新好友属性

下一篇

批量移除黑名单

当前页

返回到顶部