IM 即时通讯
iOS
动态与公告
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
产品介绍
简介
主要功能
产品优势
功能介绍
账号集成与登录
多端登录与互踢策略
基础消息功能
群组功能
聊天室功能
聊天室标签功能
圈组功能
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
跑通圈组 Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化与登录
界面跳转
自定义用户信息
全局配置
会话列表相关
集成会话列表界面
自定义会话列表 UI
会话列表 API 概览
会话消息相关
集成会话消息界面
实现地理位置消息功能
实现音视频通话
实现自定义消息收发
自定义会话消息 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录 UI
通讯录 API 概览
UIKit 功能实现方案
消息回复实现方案
IM UIKit API 概览
不含 UI 集成
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 资源场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
本地消息插入
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
离线推送
实现 APNs 离线推送
集成 APNs 推送服务
配置消息的推送属性
设置推送全局免打扰
设置多端推送策略
创建 p12 推送证书
创建 p8 密钥文件
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道分组身份组
用户定制权限
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
圈组消息缓存
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
反垃圾(内容审核)
聊天扩展
接入第三方机器人
其他
最佳实践
IM 登录最佳实践
聊天室重要消息投递
参考文档
iOS PushKit 配置
iOS苹果推送配置
API 参考
iOS SDK API
iOS SDK 状态码/错误码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置客户端应用标识
常见问题
FAQ
错题集
iOS 推送问题排查
服务协议

频道黑白名单

更新时间: 2023/04/11 17:13:47

频道黑白名单用于管控频道对服务器成员是否可见。圈组支持选择服务器成员加入黑名单或白名单,或者选择身份组将身份组所有成员批量加入黑名单或白名单。

被加入黑白名单的用户,即为黑白名单成员;被加入黑名单或白名单的身份组即为黑白名单身份组

功能介绍

频道可见性的管控属于圈组消息流转中的一环,管控方式根据频道的查看模式存在区分,具体如下:

频道查看模式
可见性管控
公开 通过频道黑名单进行管控,频道对黑名单中的服务器成员不可见,即这些成员无法访问该频道,其他服务器成员均可访问该频道
私密 通过频道白名单进行管控,频道对白名单中的服务器成员可见,即这些成员可访问该频道,其他服务器成员均无法访问该频道

前提条件

实现方法

管理黑白名单成员

更新频道黑白名单成员

用户可调用updateBlackWhiteMembers:completion:方法更新频道的黑白名单,将服务器成员加入或移出黑白名单,从而管控服务器成员是否可访问频道。

  • 调用该方法需拥有管理黑白名单的权限(NIMQChatPermissionTypeManageBlackWhiteList)。
  • 单个频道的黑白名单成员人数上限,默认为 1000。 可在云信控制台配置该数量上限,配置路径:在云信控制台选择应用,进入IM 专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 > 公开私密频道的黑白名单成员数

NIMQChatUpdateChannelBlackWhiteMembersParam为其入参结构,具体参数说明如下:

参数 类型 说明
serverId unsigned long long 服务器 ID
channelId unsigned long long 频道 ID
type NIMQChatChannelMemberRoleType 黑白名单类型
  • NIMQChatChannelMemberRoleTypeWhite:白名单
  • NIMQChatChannelMemberRoleTypeBlack:黑名单
opeType NIMQChatChannelMemberRoleOpeType 黑白名单操作类型:
  • NIMQChatChannelMemberRoleOpeTypeAdd:添加
  • NIMQChatChannelMemberRoleOpeTypeRemove:移除
accids NSArray< NSString * > * IM 账号(accid)列表:添加或者移除到黑白名单的accid列表

示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatUpdateChannelBlackWhiteMembersParam * param = [[NIMQChatUpdateChannelBlackWhiteMembersParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
// 添加白名单成员
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
param.opeType = NIMQChatQChatChannelMemberRoleOpeTypeAdd;
param.accids = @[@"yunxin1", @"yunxin2", @"yunxin3"];
[qchatChannelManager updateBlackWhiteMembers:param
    completion:^(NSError *error) {
    // your code
}];

分页查询频道黑白名单成员

调用getBlackWhiteMembersByPage:completion方法,可分页查询频道黑白名单。调用时需要传入查询的 serverIdchannelId、黑白名单类型、查询锚点时间戳timeTag 和查询数量限制limit

调用该方法需要拥有管理频道黑白名单的权限(QChatRoleResource.MANAGE_BLACK_WHITE_LIST)。


示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatGetChannelBlackWhiteMembersByPageParam * param = [[NIMQChatGetChannelBlackWhiteMembersByPageParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
param.timeTag = 0;
param.limit = 20;
// 查询白名单成员
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
[qchatChannelManager getBlackWhiteMembersByPage:param
    completion:^(NSError *__nullable error, NIMQChatGetChannelBlackWhiteMembersByPageResult *__nullable result) {
    // your code
}];

批量查询频道黑白名单成员

调用getExistingChannelBlackWhiteMembers:completion:方法可根据传入的用户账号(accid)列表查询其中已被加入的黑白名单的用户。

单次调用最多可传入 100 个 accid

示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatGetExistingChannelBlackWhiteMembersParam * param = [[NIMQChatGetExistingChannelBlackWhiteMembersParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
// 添加白名单成员
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
param.accIds = @[@"yunxin1", @"yunxin2", @"yunxin3"];
[qchatChannelManager getExistingChannelBlackWhiteMembers:param
    completion:^(NSError *__nullable error, NIMQChatGetExistingChannelBlackWhiteMembersResult *__nullable memberArray) {
    // your code
}];

管理黑白名单身份组

更新频道黑白名单身份组

调用updateBlackWhiteRole:completion:方法可选择身份组,将所选身份组的成员批量加入或移出频道黑白名单,加入黑白名单的身份组即为黑白名单身份组。调用时需要传入服务器 ID(serverId)、频道 ID(channelId)、黑白名单类型、黑白名单操作类型和身份组 ID 列表。、

  • 调用该方法需要拥有管理频道黑白名单的权限(NIMQChatPermissionTypeManageBlackWhiteList)。

  • 单个频道可设置的黑白名单身份组的数量上限,默认为 20。

    可在云信控制台配置该数量上限在云信控制台选择应用,进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 > channel公开私密频道的黑白名单身份组对象数即可配置。

示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatUpdateChannelBlackWhiteRoleParam * param = [[NIMQChatUpdateChannelBlackWhiteRoleParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
// 修改白名单成员
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
param.opeType = NIMQChatQChatChannelMemberRoleOpeTypeAdd;
param.roleId = 111;
[qchatChannelManager updateBlackWhiteRole:param
    completion:^(NSError *error) {
    // your code
}];

分页查询黑白名单身份组列表

调用getBlackWhiteRolesByPage:completion:方法可分页查询频道的黑白名单身份组列表。 调用时需要传入服务器 ID、频道 ID、黑白名单类型、查询锚点时间戳 timeTag 和查询数量限制 limit

调用该方法需要拥有管理频道黑白名单的权限(NIMQChatPermissionTypeManageBlackWhiteList)。


示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatGetChannelBlackWhiteRolesByPageParam * param = [[NIMQChatGetChannelBlackWhiteRolesByPageParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
param.timeTag = 0;
param.limit = 20;
// 查询白名单成员
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
[qchatChannelManager getBlackWhiteRolesByPage:param
    completion:^(NSError *__nullable error, NIMQChatGetChannelBlackWhiteRolesByPageResult *__nullable result) {
    // your code
}];

批量查询黑白名单身份组列表

调用getExistingChannelBlackWhiteRoles:completion:方法可根据传入的身份组 ID 列表批量查询其中被加入黑白名单的身份组。

单次调用最多可传入 100 个身份组的 ID。

示例代码如下:

id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
NIMQChatGetExistingChannelBlackWhiteRolesParam * param = [[NIMQChatGetExistingChannelBlackWhiteRolesParam alloc] init];
param.serverId = 123456;
param.channelId = 121212;
// 白名单
param.type = NIMQChatQChatChannelMemberRoleTypeWhite;
param.roleIds = @[@"111", @"222", @"333"];
[qchatChannelManager getExistingChannelBlackWhiteRoles:param
    completion:^(NSError *__nullable error, NIMQChatGetExistingChannelBlackWhiteRolesResult *__nullable roleArray) {
    // your code
}];

相关系统通知

圈组系统通知的类型在NIMQChatSystemNotificationType枚举中定义,与频道黑白名单相关的内置系统通知类型如下:

枚举值 说明
NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackMember 更新“频道黑白名单成员”
NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackRole 更新“频道黑白名单身份组”

这两种系统通知的接收条件,请参见服务端文档的频道相关事件通知

此文档是否对你有帮助?
有帮助
我要吐槽
  • 功能介绍
  • 前提条件
  • 实现方法
  • 管理黑白名单成员
  • 更新频道黑白名单成员
  • 分页查询频道黑白名单成员
  • 批量查询频道黑白名单成员
  • 管理黑白名单身份组
  • 更新频道黑白名单身份组
  • 分页查询黑白名单身份组列表
  • 批量查询黑白名单身份组列表
  • 相关系统通知