浏览器分组接口
本文档展示浏览器分组接口的请求示例和返回数据结构,用于获取团队成员的浏览器分组列表,包含分页参数和分组字段说明。
分组 Local API 文档
查询分组列表
标题
查询分组列表
简要描述
分页查询分组列表,支持按分组名称和归属用户筛选。
请求URL
http://127.0.0.1:54345/group/list
请求方式
POST
Header
| 参数 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | 请求体格式 |
X-Cos-Local-Token | 是 | YOUR_LOCAL_TOKEN | 本机访问令牌,可在客户端「设置 - Local API」中查看 |
请求Body参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
page | 否 | number | 页码,默认 1 |
page_size | 否 | number | 每页数量,默认 100,兼容 pageSize |
all | 否 | boolean/string | 传 true 或 all 时默认每页 10000 |
keyword / group_name | 否 | string | 分组名称搜索,兼容 groupName / name |
owner_uid | 否 | number/string | 归属用户 UID,兼容 ownerUid |
owner_account | 否 | string | 归属账号,兼容 ownerAccount / account |
成功返回示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": 2001,
"group_name": "测试分组",
"parent_id": 0,
"sort_num": 0,
"browserCount": 2
}
],
"total": 1,
"page": 1,
"page_size": 100
}
}
成功返回示例的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
code | number | 0 表示请求成功 |
msg | string | 返回信息 |
data.list | array | 分组列表 |
data.list[].id | number/string | 分组 ID |
data.list[].group_name | string | 分组名称 |
data.list[].parent_id | number/string | 父级分组 |
data.list[].sort_num | number | 排序值 |
data.list[].browserCount | number | 分组下窗口数量 |
data.total | number | 总数量 |
data.page | number | 当前页码 |
data.page_size | number | 每页数量 |
备注
接口只监听本机 127.0.0.1,调用前请先打开并登录客户端。
新增分组
标题
新增分组
简要描述
创建一个新的浏览器分组。
请求URL
http://127.0.0.1:54345/group/add
请求方式
POST
Header
| 参数 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | 请求体格式 |
X-Cos-Local-Token | 是 | YOUR_LOCAL_TOKEN | 本机访问令牌,可在客户端「设置 - Local API」中查看 |
请求Body参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
group_name | 是 | string | 分组名称,兼容 groupName / name |
parent_id | 否 | number/string | 父级分组,默认 0,兼容 parentCode / parentId |
sort_num | 否 | number | 排序值,默认 0,兼容 sortNum |
owner_uid | 否 | number/string | 归属用户 UID,兼容 ownerUid |
owner_account | 否 | string | 归属账号,兼容 ownerAccount / account |
成功返回示例
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "测试分组",
"transferredBrowserIds": []
}
}
成功返回示例的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
code | number | 0 表示请求成功 |
msg | string | 返回信息 |
data.id | number/string | 新增分组 ID |
data.group_name / data.groupName | string | 分组名称 |
data.transferredBrowserIds | array | 被转移到该分组的窗口 ID |
备注
新增顶级分组时 parent_id 传 0 或不传。历史字段 parentCode 仍兼容。
编辑分组
标题
编辑分组
简要描述
修改指定分组的名称、父级、排序或归属信息。
请求URL
http://127.0.0.1:54345/group/edit
请求方式
POST
Header
| 参数 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | 请求体格式 |
X-Cos-Local-Token | 是 | YOUR_LOCAL_TOKEN | 本机访问令牌,可在客户端「设置 - Local API」中查看 |
请求Body参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
id / group_id | 是 | number/string | 分组 ID |
group_name | 是 | string | 分组名称,兼容 groupName / name |
parent_id | 否 | number/string | 父级分组,默认 0,兼容 parentCode / parentId |
sort_num | 否 | number | 排序值,默认 0,兼容 sortNum |
owner_uid | 否 | number/string | 归属用户 UID,兼容 ownerUid |
owner_account | 否 | string | 归属账号,兼容 ownerAccount / account |
成功返回示例
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "新分组名",
"transferredBrowserIds": []
}
}
成功返回示例的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
code | number | 0 表示请求成功 |
msg | string | 返回信息 |
data.id | number/string | 分组 ID |
data.group_name / data.groupName | string | 修改后的分组名称 |
data.transferredBrowserIds | array | 被转移到该分组的窗口 ID |
备注
编辑分组前可先调用 /group/list 或 /group/detail 获取分组 ID。
删除分组
标题
删除分组
简要描述
根据分组 ID 删除指定分组。
请求URL
http://127.0.0.1:54345/group/delete
请求方式
POST
Header
| 参数 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | 请求体格式 |
X-Cos-Local-Token | 是 | YOUR_LOCAL_TOKEN | 本机访问令牌,可在客户端「设置 - Local API」中查看 |
请求Body参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
id | 是 | number/string | 分组 ID,也可传 group_id |
成功返回示例
{
"code": 0,
"msg": "success",
"data": {
"id": 2001
}
}
成功返回示例的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
code | number | 0 表示请求成功 |
msg | string | 返回信息 |
data.id | number/string | 已删除的分组 ID |
备注
删除分组前请确认该分组下窗口的处理方式,具体结果以客户端和服务端当前逻辑为准。
查询分组详情
标题
查询分组详情
简要描述
根据分组 ID 查询分组详情。
请求URL
http://127.0.0.1:54345/group/detail
请求方式
POST
Header
| 参数 | 必填 | 示例 | 说明 |
|---|---|---|---|
Content-Type | 是 | application/json | 请求体格式 |
X-Cos-Local-Token | 是 | YOUR_LOCAL_TOKEN | 本机访问令牌,可在客户端「设置 - Local API」中查看 |
请求Body参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
id | 是 | number/string | 分组 ID,也可传 group_id |
成功返回示例
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "测试分组",
"parent_id": 0,
"sort_num": 0,
"browserCount": 2
}
}
成功返回示例的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
code | number | 0 表示请求成功 |
msg | string | 返回信息 |
data.id | number/string | 分组 ID |
data.group_name | string | 分组名称 |
data.parent_id | number/string | 父级分组 |
data.sort_num | number | 排序值 |
data.browserCount | number | 分组下窗口数量 |
备注
如果分组不存在,可能返回 code: 404 和 msg: group not found。