窗口分组
当前团队下窗口分组的查询、创建、重命名排序与删除。分组是团队共享的一级目录,窗口通过 移动窗口到分组 归入分组。
未分组是服务端合成的固定项,id 恒为 0,出现在列表首位,不能重命名也不能删除。删除自建分组不会删除窗口,组内窗口会统一转为未分组。
显示 4 / 4 个接口
GET
/group/list窗口分组列表
查询当前团队的全部窗口分组及各分组下的窗口数量,不分页。
鉴权Bearer API Key
请求参数
无参数
注意事项
- 未分组是服务端合成的固定项,id 恒为 0,不能重命名也不能删除。
- screenCount 由服务端按当前窗口归属实时统计。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data | object[] | 分组列表,首项固定为未分组,其余按 seq 升序 |
data[].id | number | 分组 ID;0 表示未分组 |
data[].teamId | number | 分组归属团队 ID |
data[].name | string | 分组名称 |
data[].seq | number | 排序序号,未分组固定为 0 |
data[].screenCount | number | 该分组下的窗口数量 |
data[].createdAt | string | 创建时间 |
data[].updatedAt | string | 更新时间 |
响应示例
{
"code": 0,
"msg": "成功",
"data": [
{
"id": 0,
"teamId": 2001,
"name": "未分组",
"seq": 0,
"screenCount": 4,
"createdAt": "2026-06-01 12:30:00",
"updatedAt": "2026-06-01 12:30:00"
},
{
"id": 5001,
"teamId": 2001,
"name": "社媒运营",
"seq": 1,
"screenCount": 12,
"createdAt": "2026-05-20 09:15:00",
"updatedAt": "2026-05-20 09:15:00"
}
]
}
POST
/group/create创建窗口分组
在当前团队下新建一个窗口分组。
鉴权Bearer API Key
请求参数
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
name | string | 必填 | 分组名称,同团队内不可重复。缺省返回参数错误 |
seq | number | 可选 | 排序序号;缺省时服务端自动追加到当前末位之后 |
注意事项
- 同团队内分组重名时整批拒绝,返回业务失败。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data | object[] | 本次写入的分组集合 |
data[].id | number | 新建分组的 ID |
data[].teamId | number | 分组归属团队 ID |
data[].name | string | 分组名称 |
data[].seq | number | 排序序号 |
data[].createdAt | string | 创建时间 |
data[].updatedAt | string | 更新时间 |
响应示例
{
"code": 0,
"msg": "成功",
"data": [
{
"id": 5002,
"teamId": 2001,
"name": "电商店铺",
"seq": 2,
"createdAt": "2026-06-10 14:20:00",
"updatedAt": "2026-06-10 14:20:00"
}
]
}
POST
/group/modify重命名或排序窗口分组
按分组 ID 更新分组名称或排序序号。
鉴权Bearer API Key
请求参数
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
id | string | number | 必填 | 分组 ID。缺省返回参数错误 |
name | string | 可选 | 新的分组名称 |
seq | number | 可选 | 新的排序序号 |
注意事项
- 分组不属于当前团队时返回无权限;与同团队其他分组重名时整批拒绝。
- 未分组(id=0)由服务端合成,不能改名或排序。
- 兼容旧调用:id 也可写成 groupId。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data | object[] | 本次写入的分组集合 |
data[].id | number | 分组 ID |
data[].teamId | number | 分组归属团队 ID |
data[].name | string | 分组名称 |
data[].seq | number | 排序序号 |
data[].updatedAt | string | 更新时间 |
响应示例
{
"code": 0,
"msg": "成功",
"data": [
{
"id": 5002,
"teamId": 2001,
"name": "电商店铺-北美",
"seq": 2,
"updatedAt": "2026-06-11 09:05:00"
}
]
}
POST
/group/delete删除窗口分组
删除一个自建窗口分组,组内窗口会统一转为未分组。
鉴权Bearer API Key
请求参数
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
id | string | number | 必填 | 分组 ID,必须为正整数。缺省返回参数错误 |
注意事项
- 分组内的窗口不会被删除,只会被转为未分组。
- 未分组(id=0)不能删除;分组不属于当前团队时返回无权限。
- 兼容旧调用:id 也可写成 groupId。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data | null | 无返回数据,成功以 code=0 表示 |
响应示例
{
"code": 0,
"msg": "成功",
"data": null
}