检查黑名单关系

POST

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

调用此接口，可为一名用户批量检查其与至多 20 名其他用户的黑名单关系（是否已拉黑这些用户）。如需上调，请联系 ZEGO 技术支持。

说明

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

说明

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

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

。

说明

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

Request

Query Parameters

Action string必填

可选值: [CheckUsersIsInBlacklist]

接口原型参数

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

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

为此用户查询黑名单关系。

UserIds string[]必填

可选值: <= 20

待检查黑名单关系的目标用户列表。默认数量上限为 20。

Responses

application/json

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

Schema

Code integer

返回码。

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

说明

当您发起请求同时检查 FromUserId 与多名用户的黑名单关系时：

如果成功检查 FromUserId 与 1 名或更多用户的黑名单关系，Code 都会返回 0。此时请参考 ErrList 中的具体信息，确认操作结果。

如果 FromUserId 与全部目标用户的黑名单关系都检查失败，Code 会返回相关返回码，具体请参考全局返回码。

Code / SubCode	描述	处理建议
660000002	输入参数错误。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660500002	FromUserId 未注册。	请确认该用户是否已注册：确认已注册，请联系 ZEGO 技术支持排查。确认未注册，请注册此用户。
660700015	接口目标用户未注册。	请确认该用户是否已注册：确认已注册，请联系 ZEGO 技术支持排查。确认未注册，请注册此用户。
660800001	FromUserId 未注册。	请确认该用户是否已注册：确认已注册，请联系 ZEGO 技术支持排查。确认未注册，请注册此用户。
660800039	传入的用户列表超过限制。	请缩短传入的用户列表。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

Succ object[]

检查成功列表。

Array[

UserId string

成功检查 FromUserId 与此用户 ID 的黑名单关系。

Result number

可选值: [0, 1]

检查结果：

0：没被 FromUserId 拉黑。
1：已被 FromUserId 拉黑。

]

ErrList object[]

检查失败列表。

Code 为 0：
ErrList 为空，表示成功检查 FromUserId 与全部目标用户的黑名单关系。
ErrList 不为空，表示 FromUserId 与部分目标用户的黑名单关系检查失败，请参考 SubCode 处理。
Code 不为 0：
ErrList 为空，表示参数错误、接口频率限制、系统错误。
ErrList 不为空，表示FromUserId 与全部目标用户的黑名单关系检查失败。

Array[

UserId string

FromUserId 与此用户 ID 的黑名单关系检查失败。

SubCode number

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

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Succ": [
    {
      "UserId": "user1",
      "Result": 1
    }
  ],
  "ErrList": [
    {
      "UserId": "user3",
      "SubCode": 660000002
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Succ": [
    {
      "UserId": "user1",
      "Result": 1
    }
  ],
  "ErrList": [
    {
      "UserId": "user3",
      "SubCode": 660000002
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Succ": [
    {
      "UserId": "user1",
      "Result": 1
    },
    {
      "UserId": "user2",
      "Result": 1
    }
  ],
  "ErrList": [
    {
      "UserId": "user3",
      "SubCode": 660000002
    },
    {
      "UserId": "user4",
      "SubCode": 660000002
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Succ": [
    {
      "UserId": "user1",
      "Result": 1
    },
    {
      "UserId": "user2",
      "Result": 1
    }
  ],
  "ErrList": [
    {
      "UserId": "user3",
      "SubCode": 660000002
    },
    {
      "UserId": "user4",
      "SubCode": 660000002
    }
  ]
}