notifications

通知查询

请求路由: notifications

交互模型: Request Stream

访问限制: 无

请求

RSocket.rs({
  "route" : "notifications",
  "args" : {
    "search" : {
      "kind" : "unread",
      "subject" : "专线订单下单成功",
      "params" : {
        "templateName" : "购票成功通知"
      }
    },
    "pg" : {
      "size" : 10,
      "sort" : [
        "upDate;desc"
      ]
    }
  }
});

请求参数

名称	类型	必须	说明
`search`	Object	否	查询参数，所有字符串字段均支持正则表达式
`search.kind`	String	否	待查询的通知类型 unread - 未读 read - 已读 sent - 已发送 received - 所有接收的通知，包括已读和未读
`search.scope`	String	否	相关应用Scope
`search.sender`	String	否	发送者帐号
`search.recipient`	String	否	接收者帐号
`search.subject`	String	否	通知主题
`search.content`	String	否	通知内容
`search.businessKey`	String	否	关联的业务标识，例如订单通知相关的订单号等
`search.type`	String	否	normal - 普通通知; headline - 置顶通知
`search.params`	Object	否	通知参数，用于携带通知相关的一些上下文，例如 appId - 用于发送微信通知的公众号或小程序appId; smsType - 用于发送短信的模板配置名称
`search.keyword`	String	否	模糊匹配关键字
`search.from`	String	否	查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
`search.to`	String	否	查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
`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: subject - 通知主题，可选，未指定时使用Notification.subject content - 通知内容，可选，未指定时使用Notification.content sms: type - 短信类别，必须 wx: appId - 用于发送微信通知的公众号或小程序appId，必须; openId - 用于发送微信通知的用户标识，必须; push: bundleId - 用于发送App推送通知的App标识，必须; 除以上基本参数外，可以添加其他业务相关参数，以便客户端收到通知后执行特定业务逻辑
`status`	Number	通知状态 0 - 未读; 1 - 已读
`sendTypes`	String[]	通知发送类别。可同时指定多个发送类别 app - 应用内部通知 email - 邮件通知 sms - 短信通知 wx - 微信通知 push - 设备App推送通知
`crDate`	String	创建时间
`tenantId`	String	租户ID

下载结果模型定义

请求​

请求参数​

返回​

返回属性​

请求

请求参数

返回

返回属性