添加黑名单 | OpenIM Docs

跳到主要内容

添加黑名单

简要描述

将blackUserID添加到ownerUserID的黑名单中，blackUserID不能再给ownerUserID发送消息。

请求方式

post

请求URL

http://x.x.x.x:10002/friend/add_black

header名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	operationID用于全局链路追踪
token	eyJhbxxxx3Xs	必填	string	管理员token

请求参数示例

{
  "ownerUserID": "11111111",
  "blackUserID": "11111113",
  "ex":"ex"
}

字段名	选填	类型	说明
ownerUserID	必填	string	为此用户添加黑名单
blackUserID	必填	string	被拉黑的用户ID
ex	选填	string	扩展字段

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,0表示成功
errMsg	string	错误简要信息,无错误时为空
errDlt	errDlt	错误详细信息,无错误时为空
data	object	通用数据对象，具体结构见下方

失败返回示例

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息

添加黑名单