IM 即时通讯
服务端
更新日志
服务端集成新手指南
接口及业务限制
平台服务
第三方回调
第三方回调概述
消息相关回调
用户信息相关回调
高级群相关回调
超大群相关回调
聊天室相关回调
音视频1.0相关回调
IM 登录相关回调
圈组相关回调
消息抄送
消息抄送服务概述
开通消息抄送
IM会话相关抄送
IM 会话已读数据抄送
IM其他抄送
圈组相关抄送
音视频和白板相关抄送
安全通
安全通概述
开通 IM 安全通
最佳实践
聊天室重要消息投递
IM 平滑迁移方案
API 参考
API调用方式
API 概览与频控
状态码/错误码
云信 IM 账号管理
注册云信IM账号
刷新Token
封禁账号
账号全局禁言
账号功能模块禁言
设置移动端是否需要推送(桌面端在线时)
登录鉴权
消息功能
发送消息
批量发送单聊消息
发送单聊已读回执
发送群聊已读回执
消息撤回
发送广播消息
文件上传
删除单条消息
删除漫游消息
历史消息与记录
云端历史消息查询
广播消息查询
IM 登录/登出记录查询
自定义系统通知
发送自定义系统通知
批量发送自定义系统通知
用户名片
用户关系管理
好友关系管理
黑名单/静音管理
群组
高级群
创建高级群
拉人入群
发送群消息
添加管理员
移除管理员
转让群主
禁言群组
禁言指定群成员
踢人出群
主动退群
修改群昵称
修改群组信息
设置群消息提醒开关
解散群组
获取群组详细信息
获取群组禁言列表
获取群消息已读未读详情
获取用户已加入的群组信息
获取用户已加入的群组的所有群成员信息
获取群组的在线成员列表
批量获取群组信息与成员列表
批量获取群组的在线成员数量
超大群
创建超大群
拉人入群
发送超大群消息
发送超大群自定义系统通知
撤回超大群消息
添加管理员
移除管理员
转让群主
禁言超大群
禁言指定超大群成员
踢人出群
主动退群
修改超大群昵称
修改超大群信息
修改超大群成员信息
解散超大群
修改超大群人数级别
获取超大群信息
获取超大群成员信息
获取超大群禁言成员信息
获取已加入的超大群信息
查询超大群云端历史消息
聊天室
创建聊天室
获取聊天室地址
更新聊天室信息
查询聊天室信息
开放/关闭聊天室
查询开放状态的聊天室
设置聊天室定时关闭
开启/关闭进出聊天室事件通知
管理聊天室用户角色
获取聊天室成员列表
聊天室消息管理
发送聊天室消息
批量发送聊天室消息
撤回聊天室消息
发送聊天室定向消息
批量发送聊天室定向消息
发送聊天室全服广播消息
管理聊天室机器人
聊天室禁言
聊天室标签
管理聊天室队列
管理聊天室队列元素
圈组
圈组 API 概览
获取圈组连接地址
服务器相关
创建服务器
修改服务器信息
删除服务器
批量查询服务器信息
分页查询服务器列表
服务器成员相关
邀请服务器成员
接受邀请
拒绝邀请
申请加入服务器
接受申请
拒绝申请
生成邀请码
通过邀请码加入
踢出成员
主动退出服务器
修改自己的成员信息
修改他人的成员信息
分页查询服务器成员列表
批量查询服务器成员信息
查询服务器的申请和邀请记录
查询个人的申请和邀请记录
更新成员封禁状态
分页查询封禁成员列表
频道相关
创建频道
修改频道基础信息
修改频道分组相关信息
删除频道
分页查询频道列表
批量查询频道信息
分页查询频道成员列表
修改频道黑白名单成员
修改频道黑白名单身份组
分页查询频道黑白名单成员列表
分页查询频道黑白名单身份组列表
批量查询频道黑白名单成员
批量查询频道黑白名单身份组
频道分组相关
创建频道分组
修改频道分组信息
删除频道分组
批量查询频道分组信息
分页查询频道分组列表
分页查询频道分组下的频道列表
修改频道分组黑白名单身份组
修改频道分组黑白名单成员
分页查询频道分组的黑白名单身份组列表
分页查询频道分组的黑白名单成员列表
批量查询频道分组的黑白名单身份组
批量查询频道分组的黑白名单成员
身份组相关
服务器身份组
身份组成员管理
频道身份组
频道用户定制权限
频道分组身份组
频道分组用户定制权限
身份组自定义权限项
查询用户拥有的权限
圈组消息相关
发送消息
更新消息
查询云端历史消息
查询 Thread 聊天历史
批量查询Thread聊天meta 信息
更新快捷评论
查询快捷评论
查询@某人的未读消息
系统通知相关
圈组系统通知概述
发送自定义系统通知
更新自定义系统通知
搜索结果自定义排序
修改服务器自定义排序值
修改频道自定义排序值
在线状态订阅
文本翻译
推送payload配置

圈组系统通知概述

更新时间: 2023/03/09 17:45:37

圈组系统通知分类

系统通知可分为内置系统通知和自定义系统通知。

系统通知类型
说明 离线系统通知限制
内置系统通知 圈组内置的系统通知, 类型包括“邀请服务器成员”、“踢出服务器成员”、“修改频道信息” 等 服务器成员管理相关系统通知存离线,每月至多存 1000 条离线通知。其他内置系统通知不存离线
自定义系统通知 开发者自定义系统通知 每月 1,000 条离线通知

圈组系统通知分类.png

内置系统通知类型

圈组内置系统通知,按大类可分为服务器成员管理相关通知、服务器相关事件通知、频道相关事件通知、频道分组相关事件通知、身份组成员管理相关通知和身份组权限相关事件通知。除服务器成员管理相关通知外,其余类型都通过参与者与观察者机制控制通知的接收人和对应的接收条件。参与者即直接参与事件过程的用户,观察者即未直接参与事件过程但与事件相关的用户。

圈组服务器通过 QChatSystemMsgType 来定义系统通知类型。具体系统通知类型如下。

服务器成员管理相关通知

类型触发条件通知接收者接收条件
邀请服务器成员
SERVER_MEMBER_INVITE(1)
服务器成员邀请其他用户加入该服务器时 被邀请人
拒绝邀请
SERVER_MEMBER_INVITE_REJECT(2)
被邀请人拒绝加入服务器时 邀请人
申请加入服务器
SERVER_MEMBER_APPLY(3)
用户申请加入某个圈组服务器时服务器内拥有“申请邀请处理权限”的成员(最多 100 个,且随机)
拒绝申请
SERVER_MEMBER_APPLY_REJECT(4)
服务器所有者拒绝申请人加入其服务器时申请人

服务器相关事件通知

服务器相关事件通知通过参与者与观察者机制控制通知的接收人和接收条件。

  • 参与者:直接参与事件过程的圈组用户。参与者仅需要在线,就能接收到服务器相关事件通知。
  • 观察者:未直接参与事件过程但与事件相关的圈组用户。一般情况下,观察者需要在线且订阅了服务器,才能接收该服务器的事件通知。

以下表中的“删除服务器”事件为例,该事件的参与者为该服务器的所有者,观察者为该服务器的其他成员。

  • 对于成员数量小于 2,000 (可联系商务经理调整该阈值)的服务器,即使不订阅,服务器成员也能收到这些系统通知。
  • 订阅的详情介绍,请参见圈组订阅机制
类型触发条件通知接收者接收条件
创建服务器
SERVER_CREATE(5)
用户创建服务器时服务器所有者(即创建者)接收者在线
删除服务器
SERVER_REMOVE(6)
服务器所有者删除服务器时服务器全体成员和游客
  • 所有者:在线
  • 其他成员:在线且订阅该服务器
  • 游客:在线且订阅该服务器
修改服务器信息
SERVER_UPDATE(7)
拥有服务器管理权限的成员修改服务器消息时 服务器全体成员和游客
  • 所有者:在线
  • 其他成员:在线且订阅该服务器
  • 游客:在线且订阅该服务器
邀请服务器成员成功
SERVER_MEMBER_INVITE_DONE(8)
服务器所有者成功邀请他人加入服务器时 邀请人、被邀请人和其他服务器成员
  • 邀请人:在线
  • 被邀请人:在线
  • 其他成员:在线且订阅该服务器
接受邀请
SERVER_MEMBER_INVITE_ACCEPT(9)
被邀请人接收邀请时邀请人、被邀请人和其他服务器成员接收者在线且订阅该服务器
申请加入服务器成功
SERVER_MEMBER_APPLY_DONE(10)
申请人成功加入目标服务器时申请人、审批人和其他服务器成员
  • 申请人:在线
  • 审批人:在线
  • 其他成员:在线且订阅该服务器
接受申请
SERVER_MEMBER_APPLY_ACCEPT(11)
服务器所有者接受申请人加入服务器时 申请人、服务器所有者和其他服务器成员
  • 所有者:在线
  • 申请人:在线
  • 其他成员:在线且订阅该服务器
踢出服务器成员
SERVER_MEMBER_KICK(12)
拥有踢出成员权限的服务器成员踢出某个成员时 踢人者、被踢者和其他服务器成员
  • 踢人者:在线
  • 被踢者:在线
  • 其他成员:在线且订阅该服务器
主动离开服务器
SERVER_MEMBER_LEAVE(13)
服务器成员主动离开服务器时 主动离开者和其他服务器成员
  • 离开者:在线
  • 所有者:在线
  • 其他成员:在线且订阅该服务器
修改服务器成员信息
SERVER_MEMBER_UPDATE(14)
服务器成员修改自己或他人成员信息时 修改人、被修改人和其他成员
  • 修改人:在线
  • 被修改人:在线
  • 其他成员:在线且订阅该服务器
当前用户进入/离开服务器
SERVER_ENTER_LEAVE(32)
当前用户进入或者离开服务器时当前用户和其他服务器成员
  • 当前用户:在线
  • 其他成员:在线且订阅该服务器
通过邀请码加入服务器
SERVER_MEMBER_JOIN_BY_INVITE_CODE(33)
用户通过邀请码加入服务器时加入者、邀请码生成者和其他服务器成员
  • 加入者:在线
  • 邀请码生成者:在线
  • 其他成员:在线且订阅该服务器
修改 IM 用户资料触发的对服务器成员信息的联动变更
USER_INFO_UPDATE(35)
某用户未配置服务器成员信息的前提下,修改了 IM 用户资料 变更了 IM 用户资料的用户 在线

频道相关事件通知

频道相关事件通知通过参与者与观察者机制控制通知的接收人和接收条件。

  • 参与者:直接参与事件过程的频道成员。参与者仅需要在线,就能接收到频道相关事件通知。
  • 观察者:未直接参与事件过程但与事件相关的频道成员。一般情况下,观察者需要在线且订阅了服务器,才能接收该频道相关事件通知。

以下表中的“删除服务器”事件为例,该事件的参与者为该服务器的所有者,观察者为该服务器的其他成员。

  • 对于成员数量小于 2,000 (可联系商务经理调整该阈值)的频道,即使不订阅,频道成员也能收到这些系统通知。
  • 订阅的详情介绍,请参见圈组订阅机制
类型触发条件通知接收者接收条件
创建频道
CHANNEL_CREATE(15)
频道创建者创建频道时 服务器所有者、频道创建者和游客
  • 频道所有者:在线
  • 频道创建者:在线
  • 服务器创建者:在线
  • 游客:在线且订阅频道所在的服务器
删除频道
CHANNEL_REMOVE(16)
频道创建者删除频道时 服务器所有者、频道创建者和其他频道成员
  • 频道创建者:在线
  • 服务器所有者:在线
  • 其他频道成员:在线且订阅该频道
  • 游客:在线且订阅该频道
修改频道信息
CHANNEL_UPDATE(17)
频道信息被修改时 服务器所有者、修改人、其他频道成员、游客
  • 修改人:在线
  • 服务器创建者:在线
  • 其他频道成员:在线且订阅该频道
  • 游客:在线且订阅该频道
频道修改黑白名单身份组
CHANNEL_UPDATE_WHITE_
BLACK_IDENTIFY(18)
频道黑白名单身份组被修改时 修改人、涉及的黑白名单身份组成员和其他频道成员
  • 修改人:在线
  • 涉及的黑白名单身份组成员:在线(最多通知 100 名身份组成员,按分页查询的前 100 名计算)
  • 其他频道成员:在线且订阅该频道
频道修改黑白名单成员
CHANNEL_UPDATE_WHITE_
BLACK_IDENTIFY_USER(19)
频道黑白名单成员被修改时 修改人、涉及的黑白名成员和其他频道成员
  • 修改人:在线
  • 涉及的黑白名单成员:在线
  • 其他频道成员:在线且订阅该频道
更新快捷评论
UPDATE_QUICK_COMMENT(20)
快捷评论更新时(例如更新表情) 更新人、游客、其他频道成员
  • 更新人:在线
  • 游客:在线且订阅该频道
  • 其他评论参与者:在线且订阅该频道
频道对当前成员可见性变更
CHANNEL_VISIBILITY_UPDATE(31)
频道对当前用户可见性变更时(例如从不可见变为可见) 当前用户和其他频道成员
  • 当前用户:在线
  • 其他频道成员:在线且订阅该服务器
频道对当前游客可见性变更
VISITOR_CHANNEL_VISIBILITY_UPDATE(34)
频道对当前游客可见性变更时(例如从可见变为不可见) 游客
  • 游客:在线且订阅该频道

频道分组相关事件通知

频道分组相关事件通知通过参与者与观察者机制控制通知的接收人和接收条件。

  • 参与者:直接参与事件过程的频道分组成员。参与者仅需要在线,就能接收到频道分组相关事件通知。
  • 观察者:未直接参与事件过程但与事件相关的频道分组成员。一般情况下,观察者需要在线且订阅了服务器,才能接收该频道分组相关事件通知。

以下表中的“创建频道分组”事件为例,该事件的参与者为该频道分组的创建者和该服务器的所有者,观察者为该服务器的其他成员。

  • 对于成员数量小于 2,000 (可联系商务经理调整该阈值)的服务器,即使不订阅,服务器成员只需要在线也能收到这些系统通知。
  • 订阅的详情介绍,请参见圈组订阅机制
类型触发条件通知接收者接收条件
创建频道分组
CHANNEL_CATEGORY_CREATE(21)
频道分组被创建时 服务器所有者、频道分组创建者和游客
  • 服务器所有者和频道分组创建者:在线
  • 服务器的其他成员:在线且订阅该频道分组所在的服务器
  • 游客在线且已订阅该频道分组所在的服务器
删除频道分组
CHANNEL_CATEGORY_REMOVE(22)
频道分组被删除时 服务器所有者、频道分组删除者、服务器的其他成员和游客
  • 服务器所有者和频道分组删除者:在线
  • 服务器的其他成员:在线且订阅该频道分组所在的服务器
  • 游客:在线且已订阅该频道分组所在的服务器
修改频道分组信息
CHANNEL_CATEGORY_UPDATE(23)
频道分组信息被修改时 服务器所有者、修改者、服务器的其他成员和游客
  • 服务器所有者和修改者:在线
  • 服务器的其他成员:在线且订阅该频道分组所在的服务器
  • 游客:在线且已订阅该频道分组所在的服务器
频道分组修改黑白名单身份组
CHANNEL_CATEGORY_UPDATE
_WHITE_BLACK_IDENTIFY(24)
频道分组黑白名单身份组被修改时 修改者、服务器所有者、涉及的黑白名单身份组成员和服务器的其他成员
  • 修改者和服务器所有者:在线
  • 涉及的黑白名单身份组成员:在线(最多通知 100 名身份组成员,按分页查询的前 100 名计算)
  • 服务器的其他成员:在线且已订阅该频道分组所在的服务器
频道分组修改黑白名单成员
CHANNEL_CATEGORY_UPDATE_
WHITE_BLACK_IDENTIFY_USER(25)
频道分组黑白名单成员被修改时 修改者、服务器所有者、涉及的黑白名成员和服务器的其他成员
  • 修改者和服务器所有者:在线
  • 涉及的黑白名单成员:在线
  • 服务器的其他成员:在线且已订阅该频道分组所在的服务器

身份组成员管理相关通知

身份组成员管理相关事件通知通过参与者与观察者机制控制通知的接收人和接收条件。

  • 参与者:直接参与事件过程的身份组成员。参与者仅需要在线,就能接收到身份组成员管理相关通知。
  • 观察者:未直接参与事件过程但与事件相关的身份组成员。一般情况下,观察者需要在线且订阅了服务器,才能接收身份组成员管理相关通知。

以下表中的“加入服务器身份组成员”事件为例,该事件的参与者为邀请人和被邀请人,观察者为该服务器的其他成员。

  • 对于成员数量小于 2,000 (可联系商务经理调整该阈值)的服务器,即使不订阅,服务器成员只需要在线也能收到这些系统通知。
  • 订阅的详情介绍,请参见圈组订阅机制
类型触发条件通知接收者接收条件
加入服务器身份组成员
SERVER_IDENTIFY_MEMBER_ADD(26)
拥有管理服务器身份组权限的成员将某个用户添加到服务器身份组时邀请者、被邀请者、服务器其他成员
  • 邀请者和被邀请者:在线
  • 服务器其他成员:在线且订阅该服务器
移出服务器身份组成员
SERVER_IDENTIFY_MEMBER_DELETE(27)
拥有管理服务器身份组权限的成员将服务器身份组中的某个成员移出时踢出者、被踢出者、服务器其他成员
  • 踢出者和被踢出者:在线
  • 服务器的其他成员:在线且订阅该服务器

身份组权限相关事件通知

身份组权限相关事件通知通过参与者与观察者机制控制通知的接收人和接收条件。

  • 参与者:直接参与事件过程的身份组成员。参与者仅需要在线,就能接收到身份组权限相关事件通知。
  • 观察者:未直接参与事件过程但与事件相关的身份组成员。一般情况下,观察者需要在线且订阅了服务器,才能接收到身份组权限相关事件通知。

以下表中的“更新服务器身份组权限”事件为例,该事件的参与者为更新者和服务器身份组成员,暂无观察者

  • 对于成员数量小于 2,000 (可联系商务经理调整该阈值)的服务器,即使不订阅,服务器成员只需要在线也能收到这些系统通知。
  • 订阅的详情介绍,请参见圈组订阅机制
类型触发条件通知接收者接收条件
更新服务器身份组权限
SERVER_IDENTIFY_AUTH_UPDATE(28)
服务器身份组权限信息被修改时更新者、服务器身份组成员在线
更新频道身份组权限
CHANNEL_IDENTIFY_AUTH_UPDATE(29)
频道身份组权限信息被修改时更新者、服务器身份组成员在线
更新频道个人定制权限
USER_IDENTIFY_AUTH_UPDATE(30)
频道下某人定制权限信息被修改时更新者、被更新者 在线

圈组系统通知范围

上述所有系统通知事件类型,一般情况下满足参与者与观察者机制的接收条件即可接收系统通知。但是对于某些通知事件类型默认只下发给参与者,不通知观察者。具体涉及的通知事件如下:

涉及模块圈组系统通知事件
服务器相关邀请服务器成员成功、接受邀请、申请加入服务器成功、接受申请、踢出服务器成员、主动离开服务器、修改服务器成员信息、通过邀请码加入服务器、加入服务器身份组成员、移出服务器身份组成员
频道相关频道修改黑白名单身份组、频道修改黑白名单成员、频道分组修改黑白名单身份组、频道分组修改黑白名单成员

以上通知事件若需要同时通知观察者,可通过云信官网提供的联系方式咨询商务经理开通。

相关功能

功能
说明
面向服务器/频道内所有成员自定义系统通知 仅支持发送给在线账号。
面向服务器/频道内某些成员的自定义系统通知 支持系统通知存离线,最多一个月内 1000 条。如果系统通知是针对某些账号发送的(即多用户系统通知),支持保存离线系统通知,使不在线的用户在登录时获取离线系统通知。如果系统通知已存离线,接收者可更新通知状态和内容或状态,从而可以下次登录或者换设备登录时获取更新的离线通知。典型终端用户场景:将系统通知(如邀请加入圈组服务器的通知)置为待办。
此文档是否对你有帮助?
有帮助
我要吐槽
  • 圈组系统通知分类
  • 内置系统通知类型
  • 服务器成员管理相关通知
  • 服务器相关事件通知
  • 频道相关事件通知
  • 频道分组相关事件通知
  • 身份组成员管理相关通知
  • 身份组权限相关事件通知
  • 圈组系统通知范围
  • 相关功能