服务端
圈组系统通知概述
更新时间： 2024/03/15 14:31:50
圈组系统通知分类
系统通知可分为内置系统通知和自定义系统通知。
系统通知类型 |
说明 | 离线系统通知限制 |
|---|---|---|
| 内置系统通知 | 圈组内置的系统通知, 类型包括“邀请服务器成员”、“踢出服务器成员”、“修改频道信息” 等 | 服务器成员管理相关系统通知存离线，每月至多存 1000 条离线通知。其他内置系统通知不存离线 |
| 自定义系统通知 | 开发者自定义系统通知 | 每月 1,000 条离线通知 |
内置系统通知类型
圈组内置系统通知，按大类可分为服务器成员管理相关通知、服务器相关事件通知、频道相关事件通知、频道分组相关事件通知、身份组成员管理相关通知和身份组权限相关事件通知。除服务器成员管理相关通知外，其余类型都通过参与者与观察者机制控制通知的接收人和对应的接收条件。参与者即直接参与事件过程的用户，观察者即未直接参与事件过程但与事件相关的用户。
圈组服务器通过 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) | 频道黑白名单身份组被修改时 | 修改人、涉及的黑白名单身份组成员和其他频道成员 |
|
| 频道修改黑白名单成员 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) | 频道分组黑白名单身份组被修改时 | 修改者、服务器所有者、涉及的黑白名单身份组成员和服务器的其他成员 |
|
| 频道分组修改黑白名单成员 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 条。如果系统通知是针对某些账号发送的（即多用户系统通知），支持保存离线系统通知，使不在线的用户在登录时获取离线系统通知。如果系统通知已存离线，接收者可更新通知状态和内容或状态，从而可以下次登录或者换设备登录时获取更新的离线通知。典型终端用户场景：将系统通知（如邀请加入圈组服务器的通知）置为待办。 |
此文档是否对你有帮助？