即时通信 IM 拉取黑名单 - 服务端 API

功能说明

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

接口调用说明

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

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

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：

接口调试工具

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

参考

• 添加黑名单（v4/sns/black_list_add）
• 删除黑名单（v4/sns/black_list_delete）
• 校验黑名单（v4/sns/black_list_check）