IM 即时通讯(增强版)
Web
新手接入指南
产品介绍
简介
产品优势
主要功能
功能介绍
账号集成与登录
基础消息功能
群组功能
聊天室功能
圈组功能
多端登录与互踢策略
海外数据中心
IM 平滑迁移方案
接口及业务限制
更新日志
IM UIKit 更新日志
NIM SDK 更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
非React框架集成 IM UIKit
组件导入
初始化
全局上下文
登录相关
实现消息收发及界面自定义
集成会话列表界面
集成会话消息界面
集成用户资料组件
集成通讯录界面
集成搜索组件
非 React 框架自定义示渲染
主题样式设置
语言设置
初始化(兼容 NIM SDK)
不含 UI 集成
SDK 集成概述
小程序环境集成声明
初始化与登录
消息收发
历史消息
消息扩展
最近会话
用户资料托管
好友关系托管
在线状态订阅
系统通知
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
超大群概述
超大群管理
超大群成员管理
超大群消息管理
反垃圾
聊天室功能
聊天室概述
聊天室标签功能
快速实现聊天室登录
聊天室消息管理
聊天室成员管理
聊天室信息管理
聊天室队列服务
圈组功能
圈组概述
初始化与登录
通用接口校验说明
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道分组
频道分组黑白名单
频道未读数管理
实时互动频道
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
获取频道最后一条消息
会话消息回复(Thread)
圈组快捷评论
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
融合存储方案
uniapp 推送相关
最佳实践
聊天室重要消息投递
API 参考
NIM SDK API 参考
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
服务协议

频道管理

更新时间: 2023/03/14 12:04:44

NIM SDK 的QChatChannelServiceInterface提供管理频道的方法,支持创建、修改、查询和删除频道。

前提条件

创建服务器

使用限制

  • 单个服务器的频道数量上限默认为 100 个。

    可在云信控制台配置单个服务器的频道数量上限在云信控制台选择应用,进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 > 单server可创建的channel数即可配置。
  • 需拥有“管理频道的权限”(manageChannel)才能创建、修改或删除频道。权限通过身份组进行配置和管理,具体请参见身份组概述及其他身份组相关文档。

实现方法

创建频道

调用createChannel方法在某个服务器下创建频道。

  • 调用时可配置是否对传入的频道资料信息进行内容审核
  • 除消息(message)频道外,9.3.0 版本新增支持创建实时互动频道类型media),创建频道时可通过 EChannelInfoType 枚举来选择频道类型。
  • 调用时可通过visitorMode设置该频道是否对游客可见:
    • 0:对游客可见
    • 1:对游客不可见
    • 2:跟随模式(默认),即如果该频道的查看模式(viewMode)被设置为“公开”则该频道对游客可见,如果被设置为“私密”则对游客不可见
    如果频道的visitorMode为跟随模式,且同步模式(syncMode)为“与频道分组同步”,则当该频道所属的频道分组的查看模式(viewMode)变更后,该频道对游客的可见性也将变更。例如,在这种情况下,频道分组的查看模式由公开变为私密,则此时该频道对游客从“可见”变为“不可见”。

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.createChannel({
  "serverId": "12345",
  "name": "1"
})

修改频道

调用updateChannel方法修改某个频道的信息,如查看模式(公开或私密)、频道名称、频道主题、是否对游客可见、自定义扩展字段等,还可配置是否对修改的频道资料信息进行内容审核

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.updateChannel({
  "serverId": "12345",
  "name":"123"
})

删除频道

调用deleteChannel方法可将某个频道删除。

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.deleteChannel({
  "serverId": "12345"
})

频道查询

分页查询频道列表

用户进入服务器后,如果想要获取当前服务器已有(且对该用户可见)的频道,可调用getChannelsByPage方法分页查询频道列表。

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.getChannelsByPage({
  "serverId": "934978",
  "timetag": 0,
  "limit": 0
})

根据频道 ID 查询频道列表

用户进入服务器后,如果想要检索当前服务器的频道,可调用getChannels方法根据频道的 ID 进行检索。

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.getChannels({
  "channelIds": ["12345"]
})

分页查询频道成员

用户进入频道后,如果想要检索当前频道的成员有哪些(换而言之,当前频道对哪些用户可见),可调用getMembersByPage方法可分页查询频道成员列表。

示例代码如下:

const qchat = new QChat(options);
qchat.qchatChannel.getMembersByPage({
  "serverId": "934978",
  "channelId": "869553",
  "timetag": 0,
  "limit": 100
})

查询频道未读信息

用户进入服务器后,如果想获取频道的未读信息(包括未读数和未读状态),可调用getChannelUnreadInfos方法进行查询。

示例代码如下:

const qchat = new QChat({...})
qchat.qchatChannel.getChannelUnreadInfos({"channels": [
    {
      "serverId": "YOUR_SEVERID",
      "channelId": "YOUR_CHANNELID"
    }
  ]})

频道未读数管理的更多相关逻辑介绍,请参见频道未读数管理

频道资料内容审核

创建或修改频道时,如果通过AntispamTag配置了 antiSpamBusinessId, 那么云信将会对频道资料进行安全通内容审核。antiSpamBusinessId 代表安全通默认内容审核业务以外的自定义内容审核的业务 ID;如需新增自定义内容审核,请联系商务经理进行相关配置,然后前往云信控制台的安全通配置界面获取该业务 ID。

更多圈组内容审核相关说明,请参见圈组内容审核

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 使用限制
  • 实现方法
  • 创建频道
  • 修改频道
  • 删除频道
  • 频道查询
  • 分页查询频道列表
  • 根据频道 ID 查询频道列表
  • 分页查询频道成员
  • 查询频道未读信息
  • 频道资料内容审核