校验黑名单

最近更新时间:2019-05-17 18:00:19

功能说明

支持批量校验黑名单。

接口调用说明

请求 URL示例

https://console.tim.qq.com/v4/sns/black_list_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/sns/black_list_check 请求接口
sdkappid 创建应用时云通信控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号
usersig App 管理员帐号生成的签名,具体操作请参见 UserSig 后台 API
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

{
    "From_Account":"id",
    "To_Account":["id1","id2","id3","id4","id5"],
    "CheckType":"BlackCheckResult_Type_Both"
}

请求包字段说明

字段 类型 属性 说明
From_Account String 必填 需要校验该 Identifier 的黑名单
To_Account Array 必填 待校验的黑名单的 Identifier 列表,单次请求的 To_Account 数不得超过1000
CheckType String 必填 校验模式,详情可参见 校验黑名单

应答包体示例

{
    "BlackListCheckItem": [
        {
            "To_Account": "id1",
            "Relation": "BlackCheckResult_Type_BothWay",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id2",
            "Relation": "BlackCheckResult_Type_AWithB",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id3",
            "Relation": "BlackCheckResult_Type_BWithA",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id4",
            "Relation": "BlackCheckResult_Type_NO",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id5",
            "Relation": "BlackCheckResult_Type_NO",
            "ResultCode": 30007,
            "ResultInfo": "Err_SNS_BlackListCheck_Check_Reverse_BlackList_Fail"
        }
    ],
    "Fail_Account": ["id5"],
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}

应答包字段说明

字段 类型 说明
BlackListCheckItem Array 校验结果对象数组
To_Account String 请求校验的用户的 Identifier
Relation String 校验成功时 To_Account 与 From_Account 之间的黑名单关系,详情可参见 校验黑名单
ResultCode Integer To_Account 的处理结果,0表示成功,非0表示失败
ResultInfo String To_Account 的错误描述信息,成功时该字段为空
Fail_Account Array 返回处理失败的用户列表,仅当存在失败用户时才返回该字段
ActionStatus String 请求包的处理结果,“OK” 表示处理成功,“FAIL” 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 详细错误信息
ErrorDisplay String 详细的客户端展示信息

错误码说明

除非发生网络错误(例如502错误),该接口的 HTTP 返回码均为200;真正的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 描述
30001 请求参数错误,请根据错误描述检查请求参数
30003 请求的用户帐号不存在
30004 请求需要 App 管理员权限
30006 服务器内部错误,请重试
30007 网络超时,请稍后重试

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考