跳到主要内容

chat.rooms.search

搜索群

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

请求​

RSocket.rs({
"route" : "chat.rooms.search",
"args" : {
"search" : {
"scope" : "driver-app"
},
"pg" : {
"page" : 1,
"size" : 10
}
}
});

请求参数​

名称类型必须说明
searchObject否查询条件
search.scopeString否应用标识
search.nameString否按名称查找
search.memberIdString否查找指定成员所属群
search.bizKeyString否按bizKey模糊匹配
search.withMembersBoolean否结果是否包含成员列表。默认为false
search.keywordString否模糊匹配关键字
search.fromString否查询起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
search.toString否查询终止时间,时间样式为RFC3339格式,如:2019-04-19T00:13:39.649Z
pgObject否分页参数
pg.pageNumber否页码,首页从0开始
pg.sizeNumber否每页记录,默认为10
pg.sortString[]否排序字段清单,默认为升序,需要指定降序时在字段名后面添加desc并用分号隔开。
例如:["id", "crDate;desc"]

返回​

群列表

[
{
"crDate" : "2024-11-06T03:02:58.675Z",
"upDate" : "2024-11-06T03:02:58.675Z",
"tenantId" : "mzd",
"id" : "67453a6230e83f1f0fa99c96@group.mzd",
"bizKey" : "AUX202411051503297",
"scope" : "driver-app",
"owner" : "13500010001@mzd",
"name" : "XX业务讨论组",
"members" : [
{
"memberId" : "13500010001@mzd",
"name" : "wang",
"role" : "owner"
}
]
}
]

返回属性​

名称类型说明
idString群标识
bizKeyString群关联的业务标识,必须全局唯一
scopeString应用标识
ownerString群主
nameString群名称
descriptionString群公告
avatarString群头像
membersObject[]群成员
members.[].memberIdString成员标识
members.[].nameString成员昵称
members.[].roleString成员角色
  • member - 普通成员
  • admin - 管理员
  • owner - 群主
  • members.[].joinTimeString加入时间
    members.[].scopesString[]成员加入群时所属的应用标识
    historyForNewMemberBoolean新成员是否可以看到历史消息
    false时,新成员仅可看到自己加入之后的消息。默认为false
    extraPropsObject扩展属性
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID

    下载结果模型定义