黑名单

黑名单用户的消息不再投递；加入/移出立即生效。

平台调用风格

异步风格：Future<RcResult<T>>；错误码在 res.code，不使用异常表达业务失败。

接口一览​

操作语义传输返回
getBlacklist黑名单列表。REST（客户端）[{userId:string,name?:string}]
addToBlacklist加入黑名单（幂等；不能拉黑自己→1001）。REST（客户端）null
removeFromBlacklist移出黑名单。REST（客户端）null

本页 3 个操作，其中 3 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getBlacklistgetBlacklistgetBlacklistgetBlacklistgetBlacklistgetBlacklist—func
addToBlacklistaddToBlacklistaddToBlacklistaddToBlacklistaddToBlacklistaddToBlacklist—func
removeFromBlacklistremoveFromBlacklistremoveFromBlacklistremoveFromBlacklistremoveFromBlacklistremoveFromBlacklist—func

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

getBlacklist​

黑名单列表。

getBlacklist()
REST（客户端）since 1.0.0
返回

[{userId:string,name?:string}] 成功返回的数据；失败时按错误码处理

示例
Dart
final res = await engine.getBlacklist();
if (res.code != 0) throw Exception(res.msg);

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

addToBlacklist​

加入黑名单（幂等；不能拉黑自己→1001）。

addToBlacklist(String userId)
REST（客户端）幂等since 1.0.0
参数
参数类型说明
userIdstring必填；用户 ID
返回

null 无返回数据；成功与否通过错误码判断

示例
Dart
await engine.addToBlacklist('user2');
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在

removeFromBlacklist​

移出黑名单。

removeFromBlacklist(String userId)
REST（客户端）幂等since 1.0.0
参数
参数类型说明
userIdstring必填；用户 ID
返回

null 无返回数据；成功与否通过错误码判断

示例
Dart
await engine.removeFromBlacklist('user2');

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

相关文档​