平台账号

平台账号的查询、单个与批量创建，以及修改和删除。批量写入统一使用 items 集合。

在本页搜索

显示 5 / 5 个接口

GET/account/list

平台账号列表

分页查询当前登录团队的平台账号，并附带图标与已绑定窗口。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
page	number	可选	页码，默认 1
size	number	可选	每页数量，默认 20，服务端上限 1000
keyword	string	可选	关键词，模糊匹配 username 或 remark

注意事项

• 响应包含明文 password 与 key2fa，请勿把该响应转发给不受信任的调用方。

响应字段

字段	类型	说明
data.count	number	匹配到的总条数
data.size	number	每页数量，回显请求值
data.page	number	当前页码，回显请求值
data.total	number	总页数
data.data	object[]	当前页记录
data.data[].id	number	平台账号主键 ID
data.data[].userId	number	账号归属用户 ID
data.data[].teamId	number	账号归属团队 ID
data.data[].platformUrl	string	平台站点链接
data.data[].username	string	平台登录名（明文）
data.data[].password	string	平台登录密码（明文）
data.data[].key2fa	string	2FA 密钥（明文）
data.data[].remark	string	备注
data.data[].state	number	账号状态：0 正常、2 已删除
data.data[].createdAt	string	创建时间 yyyy-MM-dd HH:mm:ss
data.data[].updatedAt	string	更新时间 yyyy-MM-dd HH:mm:ss
data.data[].userEmail	string	归属用户邮箱，由服务端回填
data.data[].icon	string	平台图标地址，按 platformUrl 匹配
data.data[].bindScreen	object[]	绑定了该账号的窗口
data.data[].bindScreen[].id	number	窗口主键 ID
data.data[].bindScreen[].uuid	string	窗口目录唯一标识
data.data[].bindScreen[].name	string	窗口名称

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": {
    "count": 1,
    "size": 20,
    "page": 1,
    "total": 1,
    "data": [
      {
        "id": 5001,
        "userId": 1001,
        "teamId": 2001,
        "platformUrl": "https://x.com/",
        "username": "demo_account",
        "password": "demo-password",
        "key2fa": "JBSWY3DPEHPK3PXP",
        "remark": "",
        "state": 0,
        "createdAt": "2026-01-15 10:00:00",
        "updatedAt": "2026-06-01 12:30:00",
        "userEmail": "[email protected]",
        "icon": "https://oss.nexbrowser.net/images/platform_icon/twitter.png",
        "bindScreen": [
          {
            "id": 8001,
            "uuid": "7c2b5e9a41d84f10b6c3e0a95d824fb7",
            "name": "示例环境-01"
          }
        ]
      }
    ]
  }
}

POST/account/create

创建平台账号

把整个请求体作为一个账号项保存到当前登录团队。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
platformUrl	string	必填	平台站点链接
username	string	可选	平台登录名
platformName	string	可选	平台显示名；缺省时按 platformUrl 主机名推导
password	string	可选	平台登录密码
key2fa	string	可选	2FA 密钥，Base32 文本
remark	string	可选	备注
teamId	string | number	可选	会被服务端按当前登录团队覆盖，可省略

注意事项

• 请求体本身就是一个账号对象，不要外层再包 items；批量新增请用 /account/batch_create。
• 兼容旧调用：platformUrl 也可写成 url 或 platform.url；platform 与 platformId 字段会在转发前丢弃。

响应字段

字段	类型	说明
data	object[]	保存后的账号项，新建时 id 为新生成的主键
data[].id	number	平台账号 ID
data[].userId	number	归属用户 ID，由服务端写入
data[].teamId	number	归属团队 ID，由服务端写入
data[].platformUrl	string	平台站点链接
data[].username	string	平台登录名
data[].password	string	平台登录密码，按请求原样回显
data[].key2fa	string	2FA 密钥，按请求原样回显
data[].remark	string	备注
data[].state	number	账号状态，新建为 0

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 5003,
      "userId": 1001,
      "teamId": 2001,
      "platformUrl": "https://x.com/",
      "username": "demo_account",
      "password": "demo-password",
      "key2fa": "JBSWY3DPEHPK3PXP",
      "remark": "示例账号",
      "state": 0
    }
  ]
}

POST/account/batch_create

批量创建平台账号

批量保存平台账号，items 里的每一项都是一个独立账号。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
items	object[]	必填	账号集合，每项字段同 /account/create
items[].platformUrl	string	必填	每项的平台站点链接
items[].username	string	可选	平台登录名
items[].password	string	可选	平台登录密码
items[].key2fa	string	可选	2FA 密钥
items[].remark	string	可选	备注

注意事项

• 集合为空时后端直接返回成功且不写入任何数据。
• 兼容旧调用：items 也可写成 accounts 或 accountList。

响应字段

字段	类型	说明
data	object[]	保存后的账号项集合
data[].id	number	平台账号 ID
data[].teamId	number	归属团队 ID，由服务端写入
data[].platformUrl	string	平台站点链接
data[].username	string	平台登录名
data[].state	number	账号状态，新建为 0

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 5004,
      "teamId": 2001,
      "platformUrl": "https://x.com/",
      "username": "demo_account_1",
      "state": 0
    },
    {
      "id": 5005,
      "teamId": 2001,
      "platformUrl": "https://www.tiktok.com/",
      "username": "demo_account_2",
      "state": 0
    }
  ]
}

POST/account/modify

修改平台账号

按 id 更新一个平台账号，请求体字段与创建接口一致。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
id	number	必填	平台账号 ID；缺省或 <1 会被当作新建
platformName	string	可选	平台显示名
platformUrl	string	可选	平台站点链接
username	string	可选	平台登录名
password	string	可选	平台登录密码
key2fa	string	可选	2FA 密钥
remark	string	可选	备注

注意事项

• 账号不属于当前登录团队时该项会被静默跳过，响应仍为成功。
• 兼容旧调用：id 也可写成 accountId。

响应字段

字段	类型	说明
data	object[]	保存后的账号项
data[].id	number	平台账号 ID
data[].teamId	number	归属团队 ID
data[].platformUrl	string	平台站点链接
data[].username	string	平台登录名
data[].remark	string	备注

响应示例

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 5001,
      "teamId": 2001,
      "platformUrl": "https://x.com/",
      "username": "demo_account",
      "remark": "已更新"
    }
  ]
}

POST/account/delete

删除平台账号

软删除平台账号（state 置为 2），并从窗口的账号绑定中移除。

鉴权Bearer API Key

请求参数

字段	类型	是否必填	说明
items	number[]	必填	账号 ID 数组
teamId	string | number	可选	会被服务端按当前登录团队校验，可省略

注意事项

• 非正整数会被丢弃；ID 集合为空或账号不属于当前登录团队时后端直接返回成功且不删除任何数据。
• 兼容旧调用：items 也可写成 accountIds、accountId 或 ids，单值同样接受。

响应字段

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

响应示例

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