40.消息通知类
消息通知类
创建消息通知
- 接口描述：传入通知标题、内容、用户id、消息状态、是否弹出。
-
URL地址：http://ip:port /wapi/v1/notice
-
访问方法:：Post
-
请求参数：
Body参数
| 参数名 | 类型 | 示例值 | 必填 | 说明 |
|---|---|---|---|---|
| title | String | 123 | 是 | 通知标题 |
| content | String | 456 | 是 | 通知内容 |
| userId | Long | 94000000000058 | 是 | 用户id |
| messageStatus | Boolean | true | 是 | 消息状态 |
| noticePop | Boolean | true | 是 | 是否弹出 |
- 响应示例：
{
"code": 200,
"data": {
"id": 53000000000392,
"title": "123",
"content": "456",
"userId": 94000000000058,
"messageStatus": false,
"createTime": "2023-02-09T08:51:00.323+0000",
"lastOprTime": "2023-02-09T08:51:00.323+0000",
"jumpUrl": null,
"noticePop": true
},
"message": "success"
}
获取消息通知
- 接口描述：获取系统内所有消息通知。
- URL地址：http://ip:port /wapi/v1/notice
- 访问方法:：Get
- 请求参数：null
- 响应示例：
[
{
"id": 53000000000392,
"title": "123",
"content": "456",
"userId": 94000000000058,
"messageStatus": false,
"createTime": "2023-02-09T08:51:00.323+0000",
"lastOprTime": "2023-02-09T08:51:00.323+0000",
"jumpUrl": null,
"noticePop": true
}
]
根据状态获取消息
-
接口描述：传入消息状态，获取对应状态的所有消息通知。
-
URL地址：http://ip:port /wapi/v1 /notice/messageStatus/{messageStatus}
-
访问方法:：Get
-
请求参数：
Path参数
| 参数名 | 类型 | 示例值 | 必填 | 说明 |
|---|---|---|---|---|
| messageStatus | Boolean | true | 是 | 消息状态 |
- 响应示例：
{
"code": 200,
"data": [
{
"id": 53000000000391,
"title": "123",
"content": "456",
"userId": 94000000000058,
"messageStatus": true,
"createTime": "2023-02-09T08:50:36.440+0000",
"lastOprTime": "2023-02-09T08:50:36.440+0000",
"jumpUrl": null,
"noticePop": false
}
]
}
修改消息
-
接口描述：传入消息id，修改消息属性。
-
URL地址：http://ip:port /wapi/v1/notice/id/{noticeId}
-
访问方法:：Put
-
请求参数：
Path参数
| 参数名 | 类型 | 示例值 | 必填 | 说明 |
|---|---|---|---|---|
| noticeId | Long | 53000000000391 | 是 | 消息id |
Body参数
| 参数名 | 类型 | 示例值 | 必填 | 说明 |
|---|---|---|---|---|
| title | String | 123 | 否 | 通知标题 |
| content | String | 456 | 否 | 通知内容 |
| userId | Long | 94000000000058 | 否 | 用户id |
| messageStatus | Boolean | true | 否 | 消息状态 |
| noticePop | Boolean | true | 否 | 是否弹出 |
- 响应示例：
{
"code": 200,
"data": null,
"message": "success"
}
获取未读消息总数
-
接口描述：传入消息状态，获取对应状态消息总数。
-
URL地址：http://ip:port /wapi/v1/notice/messageStatus/count/{messageStatus}
-
访问方法:：Get
-
请求参数：
Path参数
| 参数名 | 类型 | 示例值 | 必填 | 说明 |
|---|---|---|---|---|
| messageStatus | Boolean | true | 是 | 消息状态 |
- 响应示例：
2