@alanwang-merit/meritdata-platform-skill-package 1.0.8 → 1.0.10

package/skills/meritdata-platform-messaging/references/msg-center//346/224/273/347/225/245-12-/346/266/210/346/201/257/344/270/255/345/277/203-/347/253/240/350/212/20203_/346/266/210/346/201/257/344/270/255/345/277/203/346/216/245/345/217/243/345/212/237/350/203/275/344/275/277/347/224/250.md

@@ -0,0 +1,578 @@
+---
+name: 攻略-12-消息中心-章节03_消息中心接口功能使用
+description: 消息中心接口功能使用 — 美林平台消息中心攻略（使用场景 / 页面功能 / 接口功能 / 附件）
+keywords: [消息中心, 消息管理, 消息提醒, 消息列表, 附件上传, 附件下载, 定时发送, 消息模板, 消息中心接口功能使用]
+use-cases: [消息中心页面使用, 消息发送 API, 附件上传下载, 定时消息]
+source-section: 3. 消息中心接口功能使用
+source-file: 应用开发平台-基础平台-使用攻略（十一）：消息中心.md
+---
+
+# 3.消息中心接口功能使用
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "addSendMessage",
+  "type": "http",
+  "method": "POST",
+  "urlPattern": "/api/announcement/addSendMessage",
+  "functionDesc": "发送消息（普通/定时/模板）",
+  "module": "platform",
+  "requestBody": "application/json",
+  "responseType": "ResultBody<Object>",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "HttpClientErrorException",
+    "HttpServerErrorException"
+  ],
+  "bestPractice": "捕获异常并通过 log.error 记录"
+}
+```
+
+### 3.1. 消息管理
+
+说明：发送消息，新增草稿，新增模板，新增定时发送消息
+
+字段值控制数据说明：
+
+| isSend | timeSend | isModel | isTimer | 消息类型         |
+| ------ | -------- | ------- | ------- | ---------------- |
+| 1      | 1        | 0       | 0       | 非定时已发送消息 |
+| 1      | 1        | 0       | 1       | 定时发送已发消息 |
+| 1      | 0        | 0       | 1       | 定时发送列表消息 |
+| 0      | 0        | 0       | 1       | 定时草稿         |
+| 0      | 0        | 0       | 0       | 普通草稿         |
+| 0      |          | 1       |         | 模板             |
+
+cronConfig存储json字符串值含义：
+
+| radio | moreTimeType | 定时类型     |
+| ----- | ------------ | ------------ |
+| 0     | 0            | 单次定时发送 |
+| 1     | 0            | 按年发送     |
+| 1     | 1            | 按月发送     |
+| 1     | 2            | 按日发送     |
+| 1     | 3            | 按周发送     |
+
+#### 3.1.1 新增消息接口
+
+* method : post
+
+* url : http://IP:端口/gateway/服务名/api/announcement/addSendMessage
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://IP:端口/gateway/cloud-system-manage/api/announcement/addSendMessage
+
+[IMG: image-20210701152410689]
+
+返回数据如下:
+
+```json
+{
+    "timestamp": 1669275497066,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/announcement/addSendMessage",
+    "data": {
+        "tenantId": "",
+        "secretCode": null,
+        "secretName": null,
+        "createTime": null,
+        "updateTime": 1669275497050,
+        "creatorId": null,
+        "reviserId": null,
+        "id": "4028b88184a7eba80184a892b26a00bd",
+        "isSend": "1",
+        "msgType": "0",
+        "title": null,
+        "senderId": "admin",
+        "senderName": "系统管理员",
+        "sendTime": 1669275497051,
+        "isRead": "0",
+        "detailContent": "测试普通消息",
+        "receiverId": "977df2c3b2f9451c9ba7b95338d227c4",
+        "receiverName": "测试",
+        "receiverSessionId": null,
+        "showType": null,
+        "url": null,
+        "enclosureIds": "",
+        "isModel": "0",
+        "isTimer": "0",
+        "cronConfig": null,
+        "timeSend": "1"
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+#### 3.1.2 保存模板接口
+
+- method : post
+
+- url : http://IP:端口/gateway/服务名/api/announcement/save
+
+
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://IP:端口/gateway/cloud-system-manage/api/announcement/save
+
+[IMG: image-20210701152410689]
+
+返回数据如下:
+
+```json
+{
+    "timestamp": 1625103926904,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/announcement/save",
+    "data": {
+        //多租户ID  多租户开启后不为空，不开启为空
+        "tenantId": "",
+        "secretCode": null,
+        "secretName": null,
+        "createTime": null,
+        "updateTime": 1669275644803,
+        "creatorId": null,
+        "reviserId": null,
+        //消息ID
+        "id": "4028b88184a7eba80184a894f38400be",
+        //未发送标识 0：未发送（模板不发送） 1：已发送
+        "isSend": "0",
+        //模板类型  
+        "msgType": "warn",
+        //模板标题
+        "title": " 测试",
+        //发信人userId 为PF_USER_INFO的用户userId
+        "senderId": "admin",
+        //发信人名称 为PF_USER_INFO的用户名称
+        "senderName": " 系统管理员",
+        "sendTime": 1625103926886,
+        "isRead": "0",
+        //消息内容
+        "detailContent": " <p>测试</p><p><br></p>",
+        "receiverId": null,
+        "receiverName": null,
+        "url": null,
+        "enclosureIds": " ",
+        //模板标识 如果是模板，isModel设置为1
+        "isModel": " 1",
+        //定时标识 如果是模板，isTimer设置为0
+        "isTimer": " 0",
+        "cronConfig": null,
+        "timeSend": null
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+#### 3.1.3 已发送列表
+
+- ​    method : post
+
+- ​    url : http://IP:端口/gateway/cloud-system-manage/api/announcement/page
+
+
+<b>Postman样例:</b>
+  适用于前端直接调用 
+
+ http://IP:端口/gateway/cloud-system-manage/api/announcement/page
+
+[IMG: image-20210701152410689]
+
+  返回数据如下:
+
+  ```json
+{
+    "timestamp":1622707099079,
+    "status":1,
+    "message":"成功",
+    "stackmessage":null,
+    "path":"/api/announcement/page",
+    "data":{
+        "rows"：[
+        	{
+                "tenantId":"",
+                "secretCode":null,
+                "secretName":null,
+                "createTime":null,
+                "updateTime":1622699145000,
+                "creatorId":null,
+                "reviserId":null,
+                "id":"3f28836079d0a34d0179d0b085ca0014",
+                "isSend":"1",
+                "msgType":"msg",
+                "title":"1",
+                "senderId":"admin",
+                "senderName":"系统管理员",
+                "sendTime":1622703900000,
+                "isRead":"0",
+                "detailContent":"<p>测试</p>",
+                "receiverId":"f8a8c6b1c9544096ace0e87adb26d945",
+                "receiverName":"1",
+                "url":null,
+                "enclosureIds":"",
+                "isModel":"0",//不是模板
+                "isTimer":"1",//定时发送的消息  
+                "cronConfig":"{"cron":"0 5 * * * ? *","stopTime":"2021-06-30 14:45:36","moreTimeType":"0"}",
+                "timeSend":"1"//普通已发送 定时已发送
+            }...
+        ],
+		
+        "total":25,
+        "pageSize":0,
+        "pageNumber":0,
+        "totalPages":0,
+        "records":0
+    },
+    "extraInfo":{},
+    "success":true
+}
+  ```
+
+  #### 3.1.4删除消息接口
+
+- method : post
+
+- url : http://IP:端口/gateway/cloud-system-manage/api/announcement/removeAnnouncement
+
+  <b>Postman样例:</b>
+
+http://IP:端口/gateway/cloud-system-manage/api/announcement/removeAnnouncement
+
+​    适用于前端直接调用 
+
+[IMG: image-20210701152410689]
+
+注意:传入的ids必须为数据库已有的数据
+
+ 返回数据如下:
+
+```
+true
+```
+
+#### 3.1.5消息模板列表
+
+- method : post/get
+- url : http://IP:端口/gateway/cloud-system-manage/api/announcement/modelList
+
+**Postman**样例:
+
+适用于前端直接调用 
+
+http://IP:端口/gateway/cloud-system-manage/api/announcement/modelList
+
+[IMG: image-20210701152410689]
+
+  返回数据如下:
+
+```json
+ {
+    "timestamp": 1669275774750,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/announcement/modelList",
+    "data": [
+        {
+            "id": "4028b88184a7eba80184a896dc3300bf",
+            "title": "消息模板1"
+        }
+    ],
+    "extraInfo": {},
+    "success": true
+}
+```
+
+#### 3.1.6收件人列表
+
+- method : post/get
+
+- url : http://IP:端口/gateway/cloud-system-manage/api/announcement/getRecieverByPage
+
+  **Postman**样例:
+
+   适用于前端直接调用 
+
+  http://IP:端口/gateway/cloud-system-manage/api/announcement/getRecieverByPage
+
+  请求数据如下：
+
+  [IMG: image-20210701152410689]
+
+  返回数据如下：
+
+  ```json
+  {
+      "timestamp": 1660726277007,
+    "status": 1,
+      "message": "成功",
+    "stackmessage": null,
+      "path": "/api/announcement/getRecieverByPage",
+      "data": {
+          "rows": [
+              {
+                  "tenantId": "",
+                  "secretCode": "secret40",
+                  "secretName": null,
+                  "createTime": 1660702207000,
+                  "updateTime": 1660702207000,
+                  "creatorId": null,
+                  "reviserId": null,
+                  "id": "cef4a46b17ac49aea0ccb183e3c86d52",
+                  "username": "havery",
+                  "password": "{bcrypt}$2a$10$PmRkNxf3NNVkUrsJJV6YEeeGIuy4uZUWt5UHsBlzCXVqkHdpmM64.",
+                  "status": "1",
+                  "ipAddress": null,
+                  "passChanged": 1660702267000,
+                  "passLocked": null,
+                  "macAddress": null,
+                  "errTimes": 0,
+                  "userId": "2ea5695cc08143609c72125dae7655e8",
+                  "grade": "4",
+                  "authorities": null,
+                  "authoritiesIds": null,
+                  "name": "havery",
+                  "code": null,
+                  "deptId": null,
+                  "deptCode": null,
+                  "orgId": null,
+                  "orgName": null,
+                  "rootOrgId": null,
+                  "deptName": null,
+                  "gradeName": null,
+                  "secret": null,
+                  "loginIp": null,
+                  "email": null,
+                  "threeMemberManage": false,
+                  "threeMemberManagEmpChange": false,
+                  "adminUser": false,
+                  "userType": "1",
+                  "addTime": null,
+                  "lastTime": null,
+                  "enabled": true,
+                  "credentialsNonExpired": true,
+                  "accountNonExpired": true,
+                  "accountNonLocked": true
+              }
+          ],
+          "deptcodes": null,
+          "total": 1,
+          "pageSize": 0,
+          "pageNumber": 0,
+          "totalPages": 0,
+          "records": 0
+      },
+      "extraInfo": {},
+      "success": true
+  }
+  ```
+
+  
+
+
+
+#### 3.1.7 已发送/草稿/模板/定时发送消息详情
+
+  * method : post/get
+
+  * url : http://IP:端口/gateway/cloud-system-manage/api/announcement/getMessageInfor
+
+    <b>Postman样例:</b>
+适用于前端直接调用 
+    
+      http://IP:端口/gateway/服务名//api/announcement/api/announcement/getPfMessageInfor
+    
+
+ 请求参数：
+    
+[IMG: image-20210701152410689]
+    
+    返回内容：
+    
+    ```json
+    {
+        "tenantId": "",
+        "secretCode": null,
+        "secretName": null,
+        "createTime": null,
+        "updateTime": 1660718964000,
+        "creatorId": null,
+        "reviserId": null,
+        "id": "3f28835482aa68120182aa905dc6004d",
+        "isSend": "1",
+        "msgType": "0",
+        "title": "1111",
+        "senderId": "admin",
+        "senderName": "系统管理员",
+        "sendTime": 1660718964000,
+    "isRead": "0",
+        "detailContent": "<p>1111</p>",
+        "receiverId": "01baeac963d34fe691cf442446941abc",
+    "receiverName": "wjh",
+        "receiverSessionId": null,
+    "showType": null,
+        "url": null,
+    "enclosureIds": "",
+        "isModel": "0",
+        "isTimer": "0",
+        "cronConfig": "{\"cron\":\"\",\"stopTime\":\"Wed Aug 17 2022 14:49:15 GMT+0800 (中国标准时间)86400000\",\"moreTimeType\":\"0\",\"radio\":\"1\"}",
+    "timeSend": "1"
+    }
+### 3.2.消息列表
+
+#### 3.2.1 消息列表
+
+- method : post
+
+- url : http://IP:端口/gateway/cloud-system-manage/api/announcement/pageMessage
+
+  http://localhost:8080/gateway/cloud-system-manage/api/announcement/pageMessage
+
+  Postman样例:
+
+  适用于前端直接调用 
+
+[IMG: image-20210701152410689]
+
+2.1.1 消息详情
+
+* method : post/get
+
+* url : http://IP:端口/gateway/服务名//api/announcement/getPfMessageInfor
+
+  <b>Postman样例:</b>
+适用于前端直接调用 
+  
+  http://localhost:8080/gateway/cloud-system-manage/api/announcement/getPfMessageInfor
+  
+
+请求参数：
+
+[IMG: image-20210701152410689]
+
+  返回内容：
+
+  ```json
+  {
+      "tenantId": null,
+      "secretCode": null,
+      "secretName": null,
+    "createTime": null,
+      "updateTime": 1660719720000,
+      "creatorId": null,
+    "reviserId": null,
+      "id": "3f28835482aa68120182aa9be741005c",
+    "msgType": "0",
+      "title": "信息",
+    "senderId": "admin",
+      "senderName": "系统管理员",
+      "sendTime": 1660719720000,
+      "isRead": "0",
+    "detailContent": "<p>姓名：havery</p><p>性别：男</p>",
+      "receiverId": "01baeac963d34fe691cf442446941abc",
+    "url": null,
+      "enclosureIds": "",
+      "receiverSessionId": null,
+      "showType": null
+  }
+  ```
+
+  
+
+#### 3.2.2更新未读
+
+##### 3.2.2.1 全部已读
+
+说明:查询已读/未读消息列表
+
+* method : post
+
+* url : http://IP:端口/gateway/cloud-system-manage/api/announcement/updateMessageStatus
+
+  <b>Postman样例:</b>
+  适用于前端直接调用 
+
+  http://localhost:8080/gateway/cloud-system-manage/api/announcement/updateMessageStatus
+
+  [IMG: image-20210701152410689]
+
+  返回数据如下：
+
+  ```
+  true
+  ```
+
+  
+
+
+##### 3.2.2.2 点击未读
+
+​		method : post
+
+​		url : http://IP:端口/gateway/cloud-system-manage/api/announcement/updateMessage
+
+<b>Postman样例:</b>
+适用于前端直接调用 
+
+[IMG: image-20210701152410689]
+
+返回数据如下：
+
+```
+true
+```
+
+#### 3.2.3收件人消息详情
+
+  * method : post/get
+
+  * url : http://IP:端口/gateway/cloud-system-manage/api/announcement/getPfMessageInfor
+
+    <b>Postman样例:</b>
+适用于前端直接调用 
+    
+    请求数据如下：
+    
+
+[IMG: image-20210701152410689]
+    
+返回数据如下：
+    
+    ```json
+    {
+        "tenantId": "",
+        "secretCode": null,
+        "secretName": null,
+        "createTime": null,
+        "updateTime": 1618385830000,
+        "creatorId": "",
+        "reviserId": "",
+        "id": "3f28835482aacb860182ab50a893000b",
+        "msgType": "msg",
+        "title": "222",
+    "senderId": "admin",
+        "senderName": "管理员",
+        "sendTime": 1618385830000,
+    "isRead": "1",
+        "detailContent": "111",
+    "receiverId": "2ea5695cc88143609c72125dae7655e8",
+        "url": "",
+    "enclosureIds": "",
+    "receiverSessionId": null,
+        "showType": null
+    }