chat.messages.search

搜索消息

• 请求路由: chat.messages.search
• 交互模型: Request Stream
• 访问限制: CONSOLE

请求

RSocket.rs({
  "route" : "chat.messages.search",
  "args" : {
    "search" : {
      "keyword" : "Hello"
    },
    "pg" : {
      "size" : 10,
      "sort" : [
        "seq;desc"
      ]
    }
  }
});

请求参数

名称	类型	必须	说明
search	Object	是	查询参数
search.from	String	否	消息发送者
search.to	String	否	消息接受者
search.sessionAccount	String	否	指定会话相关的帐户标识，匹配消息中的from或to
search.body	String	否	消息内容
search.scope	String	否	应用标识
search.resource	String	否	客户端资源标识
search.type	String	是	消息类型 chat - 聊天消息 groupchat - 群聊消息 app - 应用消息 invite - 邀请消息 notify - 变更通知
search.keyword	String	否	模糊匹配关键字
search.timeFrom	String	否	查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
search.timeTo	String	否	查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
search.withName	Boolean	否	查询结果是否包含发送者和接受者名称
pg	Object	否	分页参数
pg.page	Number	否	页码，首页从0开始
pg.size	Number	否	每页记录，默认为10
pg.sort	String[]	否	排序字段清单，默认为升序，需要指定降序时在字段名后面添加desc并用分号隔开。 例如：["id", "crDate;desc"]

返回

查询结果

[
  {
    "seq" : 39,
    "id" : "e6404191e56c47839288e1d3245cf0ef",
    "from" : "13500010001@mzd",
    "to" : "13500020002@mzd",
    "resource" : "127.0.0.1:58207",
    "type" : "chat",
    "body" : "Hello Taurus Chat",
    "ts" : "2024-11-03T04:08:35.845Z",
    "tenantId" : "mzd"
  },
  {
    "seq" : 32,
    "id" : "282434a38329491b97f7e549cea73287",
    "from" : "13500020002@mzd",
    "to" : "13500010001@mzd",
    "resource" : "127.0.0.1:51227",
    "type" : "chat",
    "body" : "Hello Taurus Chat",
    "ts" : "2024-11-01T08:10:15.772Z",
    "tenantId" : "mzd"
  }
]

返回属性

名称	类型	说明
seq	Number	消息序列号，可作为排序依据
ts	String	消息时间戳
tenantId	String	租户标识
id	String	消息标识
from	String	消息发送者
to	String	消息接收者
resource	String	客户端标识
type	String	消息类型 chat - 聊天消息 groupchat - 群聊消息 app - 应用消息 invite - 邀请消息 notify - 变更通知
body	String	消息内容
x	Object[]	消息扩展

下载结果模型定义