拉取黑名单

最近更新时间:2019-08-02 17:59:25

功能说明

支持分页拉取所有黑名单。

接口调用说明

请求 URL 示例

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

请求参数说明

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

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

最高调用频率

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

请求包示例

{
    "From_Account": "id",
    "StartIndex": 0,
    "MaxLimited": 30,
    "LastSequence": 12
}

请求包字段说明

字段 类型 属性 说明
From_Account String 必填 需要拉取该 Identifier 的黑名单
StartIndex Integer 必填 拉取的起始位置
MaxLimited Integer 必填 每页最多拉取的黑名单数
LastSequence Integer 必填 上一次拉黑名单时后台返回给客户端的 Seq,初次拉取时为0

应答包体示例

{
    "BlackListItem": [
        {
            "To_Account": "id1",
            "AddBlackTimeStamp": 1430000001
        },
        {
            "To_Account": "id2",
            "AddBlackTimeStamp": 1430000002
        }
    ],
    "StartIndex": 0,
    "CurruentSequence": 13,
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}

应答包字段说明

字段 类型 说明
BlackListItem Array 黑名单对象数组,每一个黑名单对象都包括了 To_Account 和 AddBlackTimeStamp
To_Account String 黑名单的 Identifier
AddBlackTimeStamp Integer 添加黑名单的时间
StartIndex Integer 下页拉取的起始位置,0表示已拉完
CurruentSequence Integer 黑名单最新的 Seq
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 在线调试工具 调试本接口。

参考