即时通信 IM 添加黑名单 - 服务端 API

功能说明

添加黑名单，支持批量添加黑名单。

注意：

• 如果用户 A 与用户 B 之间存在好友关系，拉黑时会解除双向好友关系。
• 如果用户 A 与用户 B 之间存在黑名单关系，二者之间无法发起加好友请求。
• 如果用户 A 的黑名单中有用户 B 且用户 B 的黑名单中有用户 A，二者之间无法发起会话。
• 如果用户 A 的黑名单中有用户 B 但用户 B 的黑名单中没有用户 A，那么用户 A 可以给用户 B 发消息，用户 B 不能给用户 A 发消息。

接口调用说明

请求 URL示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

{
    "From_Account":"id",
    "To_Account":["id1","id2","id3"]
}

请求包字段说明

应答包体示例

{
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id2",
            "ResultCode":30001,
            "ResultInfo":"Err_SNS_BlackListAdd_Already_Exist"
        },
        {
            "To_Account":"id3",
            "ResultCode":30002,
            "ResultInfo":"Err_SNS_BlackListAdd_SdkAppId_Illegal"
        }
    ],
    "Fail_Account":["id2","id3"],
    "ActionStatus":"OK",
    "ErrorCode":0,
    "ErrorInfo":"",
    "ErrorDisplay":""
}

应答包字段说明

错误码说明

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

接口调试工具

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

参考

• 删除黑名单（v4/sns/black_list_delete）
• 拉取黑名单（v4/sns/black_list_get）
• 校验黑名单（v4/sns/black_list_check）

可能触发的回调

添加黑名单之后回调