Docs Overview/
Chat/
服务端 API/
RESTful 接口/
用户管理/
黑名单/
拉黑用户/

拉黑用户

功能说明

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

接口调用说明

请求 URL示例

https://xxxxxx/v4/sns/black_list_add?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
https
请求协议为 HTTPS，请求方式为 POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名
中国：console.tim.qq.com
新加坡： adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/sns/black_list_add
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

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

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
请求为该 UserID 添加黑名单
To_Account
Array
必填
待添加为黑名单的用户 UserID 列表，单次请求的 To_Account 数不得超过1000

应答包体示例

{
    "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":""
}

应答包字段说明

字段
类型
说明
ResultItem
Array
批量添加黑名单的结果对象数组
To_Account
String
请求添加为黑名单的用户 UserID
ResultCode
Integer
To_Account 的处理结果，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明
ResultInfo
String
To_Account 的错误描述信息，成功时该字段为空
Fail_Account
Array
返回处理失败的用户列表，仅当存在失败用户时才返回该字段
ActionStatus
String
请求包的处理结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。 公共错误码（60000到79999）请参见 错误码。 本 API 私有错误码如下：
错误码
描述
30001
请求参数错误，请根据错误描述检查请求参数
30002
SDKAppID 不匹配
30003
请求的用户账号不存在
30004
请求需要 App 管理员权限
30006
服务器内部错误，请重试
30007
网络超时，请稍后重试
30008
并发写导致写冲突，建议使用批量方式
30013
黑名单数已达系统上限

接口调试工具

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

参考

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

可能触发的回调