检查黑名单关系

描述

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

接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=CheckUsersIsInBlacklist
传输协议：HTTPS
调用频率限制：20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	为此 UserId（已注册）查询黑名单关系。
UserIds	Array of String	是	待检查黑名单关系的目标用户列表。默认数量上限为 20。

说明

FromUserId 和 UserIds 仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

请求示例

请求地址 URL：

Untitled

https://zim-api.zego.im/?Action=CheckUsersIsInBlacklis
&<公共请求参数>

Copied!

请求消息体：

Untitled

{
    "FromUserId": "zego_user",
    "UserIds": [
        "user1",
        "user2",
        "user3",
        "user4"
    ]
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。说明当您发起请求同时检查 FromUserId 与多名用户的黑名单关系时：如果成功检查 FromUserId 与 1 名或更多用户的黑名单关系，Code 都会返回 0。此时请参考 ErrList 中的具体信息，确认操作结果。如果 FromUserId 与全部目标用户的黑名单关系都检查失败，Code 会返回相关返回码，具体请参考全局返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Succ	Array of Object	检查成功列表。
└UserId	String	成功检查 `FromUserId` 与此用户 ID 的黑名单关系。
└Result	Number	检查结果： 0：没被 FromUserId 拉黑。 1：已被 FromUserId 拉黑。
ErrList	Array of Object	检查失败列表。 Code 为 0： ErrList 为空，表示成功检查 `FromUserId` 与全部目标用户的黑名单关系。 ErrList 不为空，表示 `FromUserId` 与部分目标用户的黑名单关系检查失败，请参考 SubCode 处理。 Code 不为 0： ErrList 为空，表示参数错误、接口频率限制、系统错误。 ErrList 不为空，表示`FromUserId` 与全部目标用户的黑名单关系检查失败。
└UserID	String	`FromUserId` 与此用户 ID 的黑名单关系检查失败。
└SubCode	Number	具体失败返回码。

响应示例

Untitled

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

Copied!

返回码

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

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