浏览器分组接口

本文档展示浏览器分组接口的请求示例和返回数据结构,用于获取团队成员的浏览器分组列表,包含分页参数和分组字段说明。

分组 Local API 文档

查询分组列表

标题

查询分组列表

简要描述

分页查询分组列表,支持按分组名称和归属用户筛选。

请求URL

http://127.0.0.1:54345/group/list

请求方式

POST

参数必填示例说明
Content-Typeapplication/json请求体格式
X-Cos-Local-TokenYOUR_LOCAL_TOKEN本机访问令牌,可在客户端「设置 - Local API」中查看

请求Body参数

参数必填类型说明
pagenumber页码,默认 1
page_sizenumber每页数量,默认 100,兼容 pageSize
allboolean/stringtrueall 时默认每页 10000
keyword / group_namestring分组名称搜索,兼容 groupName / name
owner_uidnumber/string归属用户 UID,兼容 ownerUid
owner_accountstring归属账号,兼容 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
  }
}

成功返回示例的参数说明

参数类型说明
codenumber0 表示请求成功
msgstring返回信息
data.listarray分组列表
data.list[].idnumber/string分组 ID
data.list[].group_namestring分组名称
data.list[].parent_idnumber/string父级分组
data.list[].sort_numnumber排序值
data.list[].browserCountnumber分组下窗口数量
data.totalnumber总数量
data.pagenumber当前页码
data.page_sizenumber每页数量

备注

接口只监听本机 127.0.0.1,调用前请先打开并登录客户端。

新增分组

标题

新增分组

简要描述

创建一个新的浏览器分组。

请求URL

http://127.0.0.1:54345/group/add

请求方式

POST

Header

参数必填示例说明
Content-Typeapplication/json请求体格式
X-Cos-Local-TokenYOUR_LOCAL_TOKEN本机访问令牌,可在客户端「设置 - Local API」中查看

请求Body参数

参数必填类型说明
group_namestring分组名称,兼容 groupName / name
parent_idnumber/string父级分组,默认 0,兼容 parentCode / parentId
sort_numnumber排序值,默认 0,兼容 sortNum
owner_uidnumber/string归属用户 UID,兼容 ownerUid
owner_accountstring归属账号,兼容 ownerAccount / account

成功返回示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2001,
    "group_name": "测试分组",
    "transferredBrowserIds": []
  }
}

成功返回示例的参数说明

参数类型说明
codenumber0 表示请求成功
msgstring返回信息
data.idnumber/string新增分组 ID
data.group_name / data.groupNamestring分组名称
data.transferredBrowserIdsarray被转移到该分组的窗口 ID

备注

新增顶级分组时 parent_id0 或不传。历史字段 parentCode 仍兼容。

编辑分组

标题

编辑分组

简要描述

修改指定分组的名称、父级、排序或归属信息。

请求URL

http://127.0.0.1:54345/group/edit

请求方式

POST

Header

参数必填示例说明
Content-Typeapplication/json请求体格式
X-Cos-Local-TokenYOUR_LOCAL_TOKEN本机访问令牌,可在客户端「设置 - Local API」中查看

请求Body参数

参数必填类型说明
id / group_idnumber/string分组 ID
group_namestring分组名称,兼容 groupName / name
parent_idnumber/string父级分组,默认 0,兼容 parentCode / parentId
sort_numnumber排序值,默认 0,兼容 sortNum
owner_uidnumber/string归属用户 UID,兼容 ownerUid
owner_accountstring归属账号,兼容 ownerAccount / account

成功返回示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2001,
    "group_name": "新分组名",
    "transferredBrowserIds": []
  }
}

成功返回示例的参数说明

参数类型说明
codenumber0 表示请求成功
msgstring返回信息
data.idnumber/string分组 ID
data.group_name / data.groupNamestring修改后的分组名称
data.transferredBrowserIdsarray被转移到该分组的窗口 ID

备注

编辑分组前可先调用 /group/list/group/detail 获取分组 ID。

删除分组

标题

删除分组

简要描述

根据分组 ID 删除指定分组。

请求URL

http://127.0.0.1:54345/group/delete

请求方式

POST

Header

参数必填示例说明
Content-Typeapplication/json请求体格式
X-Cos-Local-TokenYOUR_LOCAL_TOKEN本机访问令牌,可在客户端「设置 - Local API」中查看

请求Body参数

参数必填类型说明
idnumber/string分组 ID,也可传 group_id

成功返回示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2001
  }
}

成功返回示例的参数说明

参数类型说明
codenumber0 表示请求成功
msgstring返回信息
data.idnumber/string已删除的分组 ID

备注

删除分组前请确认该分组下窗口的处理方式,具体结果以客户端和服务端当前逻辑为准。

查询分组详情

标题

查询分组详情

简要描述

根据分组 ID 查询分组详情。

请求URL

http://127.0.0.1:54345/group/detail

请求方式

POST

Header

参数必填示例说明
Content-Typeapplication/json请求体格式
X-Cos-Local-TokenYOUR_LOCAL_TOKEN本机访问令牌,可在客户端「设置 - Local API」中查看

请求Body参数

参数必填类型说明
idnumber/string分组 ID,也可传 group_id

成功返回示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2001,
    "group_name": "测试分组",
    "parent_id": 0,
    "sort_num": 0,
    "browserCount": 2
  }
}

成功返回示例的参数说明

参数类型说明
codenumber0 表示请求成功
msgstring返回信息
data.idnumber/string分组 ID
data.group_namestring分组名称
data.parent_idnumber/string父级分组
data.sort_numnumber排序值
data.browserCountnumber分组下窗口数量

备注

如果分组不存在,可能返回 code: 404msg: group not found

最近修改: 2026-06-30