跳到主要内容

黑名单管理

将用户加入黑名单之后，将不再收到对方发来的任何单聊消息。

  • 加入黑名单为单向操作，例如：用户 A 拉黑用户 B，代表 B 无法给 A 发消息（错误码 405）。但 A 向 B 发消息，B 仍然能正常接收。
  • 单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。
  • 调用服务端 API 发送单聊消息默认不受黑名单限制。如需启用限制，请在调用 API 时设置 verifyBlacklist 为 1。

加入黑名单​

将某个用户加入黑名单。

方法​

C #
int addToBlacklist(string userId)

参数说明​

参数类型说明
userIdstring用户 id

返回值​

返回值描述
int当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法​

  • onBlacklistAdded
C #
delegate void OnBlacklistAddedDelegate(int code, string userId);

OnBlacklistAddedDelegate onBlacklistAdded;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
userIdstring用户 ID

代码示例

C #
engine.onBlacklistAdded = delegate(int code, string userId)
{
};

移除黑名单​

将某个用户从黑名单中移出。

方法​

C #
int removeFromBlacklist(string userId);

参数说明​

参数类型说明
userIdstring用户 id

返回值​

返回值描述
int当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法​

  • onBlacklistRemoved
C #
delegate void OnBlacklistRemovedDelegate(int code, string userId);

OnBlacklistRemovedDelegate onBlacklistRemoved;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
userIdstring用户 ID

代码示例

C #
engine.onBlacklistRemoved = delegate(int code, string userId)
{
};

查询用户是否在黑名单中​

获取某用户是否在黑名单中。

方法​

C #
int loadBlacklistStatus(string userId);

参数说明​

参数类型说明
userIdstring用户 id

返回值​

返回值描述
int当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法​

  • onBlacklistStatusLoaded
C #
delegate void OnBlacklistStatusLoadedDelegate(int code, string userId, RCIMBlacklistStatus status);

OnBlacklistStatusLoadedDelegate onBlacklistStatusLoaded;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
userIdstring用户 ID
statusRCIMBlacklistStatus当前状态

代码示例

C #
engine.onBlacklistStatusLoaded = delegate(int code, string userId, RCIMBlacklistStatus status)
{
};

获取黑名单列表​

获取当前用户设置的黑名单列表。

方法​

C #
int loadBlacklist();

返回值​

返回值描述
int当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法​

  • onBlacklistLoaded
C #
delegate void OnBlacklistLoadedDelegate(int code, List<string> userIds);

OnBlacklistLoadedDelegate onBlacklistLoaded;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
userIdsList<string>用户 ID 集合

代码示例

C #
engine.onBlacklistLoaded = delegate(int code, List<string> userIds)
{
};