团队

团队列表、单个与批量成员邀请，以及团队的新建、修改和删除。团队相关接口转发到服务端，需要客户端已登录。

在本页搜索

显示 5 / 5 个接口

GET/team/list

团队列表

查询当前登录账号可访问的全部团队，不分页。

鉴权Bearer API Key

请求参数

无参数

响应字段

字段	类型	说明
`data`	`object[]`	团队列表
`data[].id`	`number`	团队主键 ID，即各接口的 teamId
`data[].userId`	`number`	团队创建人用户 ID
`data[].name`	`string`	团队名称
`data[].windowNum`	`number`	已占用窗口数
`data[].memberNum`	`number`	已占用成员数
`data[].remark`	`string`	团队备注
`data[].limitWindow`	`number`	窗口配额上限
`data[].limitMember`	`number`	成员配额上限
`data[].combo`	`string`	套餐编码，如 COMBO_1
`data[].comboExpire`	`string`	套餐到期时间
`data[].actived`	`string`	启用开关：ON、OFF
`data[].createdAt`	`string`	创建时间
`data[].updatedAt`	`string`	更新时间
`data[].creater`	`string`	创建人邮箱
`data[].teamMember`	`object`	当前登录账号在该团队的成员信息
`data[].teamMember.roleId`	`number`	角色 ID，0 表示普通成员
`data[].teamMember.nick`	`string`	成员昵称
`data[].teamMember.switchPinned`	`string`	置顶开关：ON、OFF
`data[].teamMember.role`	`object`	角色详情，普通成员为 null
`data[].teamMember.role.name`	`string`	角色名称
`data[].teamMember.role.menuId`	`string`	角色菜单权限 ID 列表的 JSON 文本

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 2001,
      "userId": 1001,
      "name": "默认团队",
      "windowNum": 3,
      "memberNum": 2,
      "remark": "default team",
      "limitWindow": 50,
      "limitMember": 10,
      "combo": "COMBO_1",
      "comboExpire": "2027-01-15 23:59:59",
      "actived": "ON",
      "createdAt": "2026-01-15 10:00:00",
      "updatedAt": "2026-06-01 12:30:00",
      "creater": "[email protected]",
      "teamMember": {
        "id": 3001,
        "teamId": 2001,
        "userId": 1001,
        "roleId": 4001,
        "nick": "[email protected]",
        "seq": 1,
        "switchPinned": "OFF",
        "createdAt": "2026-01-15 10:00:00",
        "updatedAt": "2026-01-15 10:00:00",
        "role": {
          "id": 4001,
          "teamId": 2001,
          "name": "管理员",
          "menuId": "[1, 2, 3, 4, 5]",
          "createdAt": "2026-01-15 10:00:00",
          "updatedAt": "2026-06-01 12:30:00"
        }
      }
    }
  ]
}

POST/team/invite

邀请团队成员

按邮箱把一个已注册用户加入当前登录团队，并发送站内通知。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
`email`	`string`	必填	受邀用户的注册邮箱；未注册返回用户不存在

注意事项

目标团队固定为当前登录团队，不接受 teamId 参数；新成员 roleId 为 0（普通成员）。
成员数超过团队 limitMember 或套餐已过期时返回业务失败。

响应字段

字段	类型	说明
`data`	`null`	无返回数据，成功以 code=0 表示

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": null
}

POST/team/batch_invite

批量邀请团队成员

与 /team/invite 转发同一后端命令，单次仍只处理一个 email，批量邀请需逐个调用。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
`email`	`string`	必填	受邀用户的注册邮箱

注意事项

后端命令只读取单个 email 字段，传入邮箱数组不会生效。

响应字段

字段	类型	说明
`data`	`null`	无返回数据，成功以 code=0 表示

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": null
}

POST/team/modify

新建或修改团队

保存团队信息；带 item.id 为修改，不带为新建并自动创建管理员角色。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
`item`	`object`	必填	团队对象，团队字段都写在这一层
`item.id`	`number`	可选	团队 ID；缺省表示新建，非创建人修改返回无权限
`item.name`	`string`	可选	团队名称
`item.remark`	`string`	可选	团队备注

注意事项

combo、comboExpire、windowNum、memberNum、limitWindow、limitMember、actived 会被服务端清空，无法通过本接口修改。

响应字段

字段	类型	说明
`data.id`	`number`	团队 ID，新建时为新生成的 ID
`data.userId`	`number`	团队归属用户 ID，服务端按当前登录账号写入
`data.name`	`string`	团队名称
`data.remark`	`string`	团队备注

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": {
    "id": 2001,
    "userId": 1001,
    "name": "默认团队",
    "remark": "default team"
  }
}

POST/team/delete

删除团队

批量删除自己创建的团队，并把团队成员切出该团队。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
`items`	`number[]`	必填	团队 ID 数组

注意事项

存在非本人创建的团队、包含当前登录团队、或团队下仍有窗口未清空时，整批拒绝并返回对应业务错误。

响应字段

字段	类型	说明
`data`	`null`	无返回数据，成功以 code=0 表示

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": null
}