查询黑名单

GET

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

根据用户 ID 分页拉取其全量黑名单数据。

说明

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

Request

Query Parameters

Action string必填

可选值: [QueryBlacklist]

接口原型参数

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

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

查询此 UserID（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册）的黑名单列表。

Limit number必填

可选值: >= 0 and <= 100

单次拉取多少名用户的信息。取值范围为 [0, 100]。如果不填或数值为 0、大于 100，取值为 100。

Next number必填

分页拉取标志，第一次填 0，之后填上一次返回的 Next 值。当返回的 Next 为 0 时，代表黑名单获取完毕。

例如，FromUserId 拉黑了 250 名用户，调用本接口查询时：

第一次调用本接口，Limit 填 100，Next 传空，查询第 1 ～ 100 名用户；返回结果中的 Next 值为 num1。
第二次调用本接口，Limit 填 100，Next 填 num1，查询第 101 ～ 200 名用户；返回结果中 Next 值为 num2。
第三次调用本接口，Limit 填 100，Next 填 num2，查询第 201 ～ 250 名用户；查询完毕，返回结果中的 Next 为 0。

Responses

application/json

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

Schema

Code integer

返回码。

返回码	说明	处理建议
660000002	参数错误。	请检查请求参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660500002	FromUserId 未注册。	请确认该用户是否已注册：确认已注册，请联系 ZEGO 技术支持排查。确认未注册，请注册此用户。
660800001	FromUserId 未注册。	请确认该用户是否已注册：确认已注册，请联系 ZEGO 技术支持排查。确认未注册，请注册此用户。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

TotalCount int32

当前黑名单用户总数。

Next number

分页拉取标志，非 0 表示还有黑名单信息未返回，需要将该字段设置到请求参数 Next 中拉取更多黑名单信息；为 0 表示已经返回所有黑名单信息。

说明

除上述说明之外，此字段与列表信息无任何关联，请勿基于此做任何其他逻辑。

Blacklist object[]

黑名单数据列表。

Array[

UserId string

用户 ID。

UserName string

用户名称。

Avatar string

用户头像地址。

UpdateTime number

拉黑时间，单位为 ms。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1,
  "Blacklist": [
    {
      "UserId": "usera1",
      "UserName": "Nicknamea1",
      "Avatar": "Avatar1",
      "UpdateTime": 1698310534000
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1,
  "Blacklist": [
    {
      "UserId": "usera1",
      "UserName": "Nicknamea1",
      "Avatar": "Avatar1",
      "UpdateTime": 1698310534000
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1,
  "Blacklist": [
    {
      "UserId": "usera1",
      "UserName": "Nicknamea1",
      "Avatar": "Avatar1",
      "UpdateTime": 1698310534000
    },
    {
      "UserId": "usera2",
      "UserName": "Nicknamea2",
      "Avatar": "Avatar2",
      "UpdateTime": 1698310534000
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 500,
  "Next": 1,
  "Blacklist": [
    {
      "UserId": "usera1",
      "UserName": "Nicknamea1",
      "Avatar": "Avatar1",
      "UpdateTime": 1698310534000
    },
    {
      "UserId": "usera2",
      "UserName": "Nicknamea2",
      "Avatar": "Avatar2",
      "UpdateTime": 1698310534000
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。