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
}
}
});
请求参数
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
search | Object | 否 | 查询条件 |
search.scope | String | 否 | 应用标识 |
search.name | String | 否 | 按名称查找 |
search.memberId | String | 否 | 查找指定成员所属群 |
search.bizKey | String | 否 | 按bizKey模糊匹配 |
search.withMembers | Boolean | 否 | 结果是否包含成员列表。默认为false |
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"] |
返回
群列表
[
{
"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"
}
]
}
]
返回属性
| 名称 | 类型 | 说明 |
|---|---|---|
id | String | 群标识 |
bizKey | String | 群关联的业务标识,必须全局唯一 |
scope | String | 应用标识 |
owner | String | 群主 |
name | String | 群名称 |
description | String | 群公告 |
avatar | String | 群头像 |
members | Object[] | 群成员 |
members.[].memberId | String | 成员标识 |
members.[].name | String | 成员昵称 |
members.[].role | String | 成员角色 |
members.[].joinTime | String | 加入时间 |
members.[].scopes | String[] | 成员加入群时所属的应用标识 |
historyForNewMember | Boolean | 新成员是否可以看到历史消息 false时,新成员仅可看到自己加入之后的消息。默认为false |
extraProps | Object | 扩展属性 |
crDate | String | 创建时间 |
upDate | String | 最后修改时间 |
tenantId | String | 租户ID |