圈组系统通知是用户在使用圈组功能的过程中，由云信 IM 下发给用户相关事件的通知，比如圈组服务器中的成员变更，频道变更等事件。

功能介绍

圈组内置系统通知只能通过具体事件触发，由云信 IM 发送给相关的圈组用户。用户只需注册圈组系统通知的相关监听，就能接收到对应的系统通知。

圈组自定义系统通知支持用户主动发送，并可以指定发送给全员或部分成员。

云信 IM SDK 的 nim_qchat::SystemNotification 模块提供管理圈组系统通知的相关方法以及监听圈组系统通知的相关方法，帮助您快速实现对圈组系统通知的管理。

NIM SDK 中的 NIMQChatSystemNotification 定义了圈组的系统通知，其参数说明如下：

实现方法

本文以服务器所有者（即创建者）和服务器成员的交互为例，介绍服务器所有者发送圈组自定义系统通知的实现流程和触发内置圈组系统通知的实现流程。

前提条件

• 已接入圈组，并已创建圈组服务器。
• 已创建云信 IM 账号，作为下文中服务器所有者和服务器成员的云信 IM 账号。

实现流程

sequenceDiagram



note over 圈组: 初始化SDK并登录IM
note over 圈组: 注册监听并登录圈组
服务器所有者 ->> 圈组: 登录圈组
服务器成员 ->> 圈组: 监听圈组系统通知接收事件
服务器成员 ->> 圈组: 登录圈组
note over 圈组: 圈组系统通知收发
服务器所有者 ->> 圈组: 发送自定义系统通知
圈组 ->> 服务器成员: 投递自定义系统通知
服务器成员 ->> 圈组: 标记系统通知已读
服务器所有者 ->> 圈组: 删除圈组服务器
note left of 圈组: 以“删除圈组服务器”类型的内置系统通知为例进行触发
圈组 ->> 服务器所有者: 投递圈组内置系统通知
圈组 ->> 服务器成员: 投递圈组内置系统通知

以下只对部分重要步骤进行说明：

1. 服务器成员注册监听 RegRecvCb 监听圈组系统通知的接收。

   示例代码：

   QChatRegRecvSystemNotificationCbParam reg_receive_sysmessage_cb_param;
   reg_receive_sysmessage_cb_param.cb = [this](const QChatRecvSystemNotificationResp& resp) {
       if (resp.res_code != NIMResCode::kNIMResSuccess) {
           // error handling
           return;
       }
       // process response
       // ...
   };
   SystemNotification::RegRecvCb(reg_receive_sysmessage_cb_param);
   

2. 服务器所有者通过调用 Send 发送圈组自定义系统通知。其中 QChatSendSystemNotificationParam 是发送圈组自定义系统通知入参。

   示例代码：

   QChatSendSystemNotificationParam param;
   param.notification.server_id = 123456;
   param.notification.channel_id = 123456;
   param.notification.msg_type = kNIMQChatSystemNotificationTypeCustom;
   param.notification.msg_body = "msg body";
   param.notification.msg_attach = "msg attach";
   param.notification.msg_ext = "msg ext";
   param.notification.resend_flag = false;
   param.notification.msg_id = ""; // only for resend. if not, leave it empty, we will generate it
   param.notification.to_accids = {"accid1", "accid2"};
   param.notification.history_enable = false;
   param.notification.push_payload = "push payload";
   param.notification.push_content = "push content";
   param.notification.push_enable = false;
   param.notification.need_badge = true;
   param.notification.need_push_nick = true;
   param.cb = [this](const QChatSendSystemNotificationResp& resp) {
       if (resp.res_code != NIMResCode::kNIMResSuccess) {
           // error handling
           return;
       }
       // process response
       // ...
   };
   SystemNotification::Send(param);
   

3. 服务器成员收到来自服务器所有者的自定义系统通知。

4. 服务器成员通过调用 MarkSystemNotificationsRead 标记圈组系统通知已读。

   标记已读后的系统通知将从服务端删除，后续不会在其他端接收。

   示例代码：

   QChatMarkSystemNotificationsReadParam param;
   NIMQChatSystemNotificationMarkReadInfo info;
   info.msg_server_id = 123456;
   info.msg_type = kNIMQChatSystemNotificationTypeCustom;
   param.mark_read_infos.emplace_back(info);
   param.cb = [this](const QChatMarkReadSystemNotificationResp& resp) {
       if (resp.res_code != NIMResCode::kNIMResSuccess) {
           // error handling
           return;
       }
       // process response
       // ...
   };
   SystemNotification::MarkSystemNotificationsRead(param);
   

5. 服务器所有者调用 DeleteServer 方法删除圈组服务器。

   示例代码：

   QChatServerDeleteParam param;
   param.server_id = 123456;
   param.cb = [this](const QChatServerDeleteResp& resp) {
       if (resp.res_code != NIMResCode::kNIMResSuccess) {
           // error handling
           return;
       }
       // process response
       // ...
   };
   Server::DeleteServer(param);
   

6. 服务器所有者和服务器成员收到系统投递的内置系统通知。

   该示例收到类型为“删除服务器”的系统通知，更多事件类型和相应的通知接收条件，请参见圈组系统通知分类和圈组系统通知接收机制。

7. （可选）如果因为网络等原因，自定义系统通知发送失败，用户可以调用 Send 方法，将系统通知的 resend_flag 设置为 true，重新发送圈组自定义系统通知。 示例代码如下：

   QChatSendSystemNotificationParam param;
   param.notification.server_id = 123456;
   param.notification.channel_id = 123456;
   param.notification.msg_type = kNIMQChatSystemNotificationTypeCustom;
   param.notification.msg_body = "msg body";
   param.notification.msg_attach = "msg attach";
   param.notification.msg_ext = "msg ext";
   param.notification.resend_flag = true;
   param.notification.msg_id = ""; // only for resend. if not, leave it empty, we will generate it
   param.notification.to_accids = {"accid1", "accid2"};
   param.notification.history_enable = false;
   param.notification.push_payload = "push payload";
   param.notification.push_content = "push content";
   param.notification.push_enable = false;
   param.notification.need_badge = true;
   param.notification.need_push_nick = true;
   param.cb = [this](const QChatSendSystemNotificationResp& resp) {
       if (resp.res_code != NIMResCode::kNIMResSuccess) {
           // error handling
           return;
       }
       // process response
       // ...
   };
   SystemNotification::Send(param);