notifications.all
获取当前用户的所有通知
- 请求路由:
notifications.all- 交互模型:
Request Stream- 访问限制: 无
请求
RSocket.rs({
"route" : "notifications.all",
"args" : {
"type" : "normal",
"keyword" : "",
"pg" : {
"page" : 0,
"size" : 10
}
}
});
请求参数
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
type | String | 否 | 通知类型 |
keyword | String | 否 | 查询关键字 |
pg | Object | 否 | 分页参数 |
pg.page | Number | 否 | 页码,首页从0开始 |
pg.size | Number | 否 | 每页记录,默认为10 |
pg.sort | String[] | 否 | 排序字段清单,默认为升序,需要指定降序时在字段名后面添加desc并用分号隔开。 例如:["id", "crDate;desc"] |
返回
通知列表
[
{
"tenantId" : "mzd",
"id" : "6483c02eedb4f1131ba68047",
"scope" : "cbv",
"sender" : "admin",
"recipient" : "18900010001@mzd",
"subject" : "专线订单下单成功",
"content" : "",
"businessKey" : "order:SCO20230610081326748",
"type" : "normal",
"params" : {
"templateName" : "购票成功通知",
"appId" : "wx810cb7d88888888e",
"driverDisplay" : false
},
"status" : 0,
"sendTypes" : [
"app",
"sms",
"wx"
]
}
]
返回属性
| 名称 | 类型 | 说明 |
|---|---|---|
id | String | 通知标识 |
scope | String | 相关应用Scope |
sender | String | 发送者帐号 |
recipient | String | 接收者帐号 |
subject | String | 通知主题 |
content | String | 通知内容 |
businessKey | String | 关联的业务标识,例如订单通知相关的订单号等 |
type | String | normal - 会持久化的普通通知 headline - 不会持久化的实时通知,仅在线用户可以收到这类通知 |
params | Object | 通知参数,用于携带通知相关的一些上下文,不同sendType所需的基本params不同:email:除以上基本参数外,可以添加其他业务相关参数,以便客户端收到通知后执行特定业务逻辑 |
status | Number | 通知状态 0 - 未读; 1 - 已读 |
sendTypes | String[] | 通知发送类别。 可同时指定多个发送类别 |
crDate | String | 创建时间 |
tenantId | String | 租户ID |