Files
acfunlive-remake/doc/webapi.md
T
tamakyi 7a396a8852 web UI:目录和文件既能点「浏览」逐级选,也能手工填
浏览器拿不到本地绝对路径,所以「交互式选择」做成后端列目录 + 弹窗点选:

- 新增 GET /api/browse:path 为空时用程序所在目录,kind=file 连文件一起列,
  hidden=1 带上点开头的隐藏项;文件夹优先排序,上限 2000 项。打不开时仍返回
  200 并带上 error 和 parent —— 页面据此自动向上退,不会把用户卡在一个打不开
  的路径里(框里填的是文件路径时,就是这样落到它所在的目录的)。权限没放宽,
  和其它管理接口一样走口令。
- 文件保存目录、成片移动到、ffmpeg 路径、手动合并的弹幕文件这四个框加了
  「浏览…」按钮,输入框本身照旧可以直接填或粘贴;弹窗里的地址栏也能粘贴路径
  回车跳转,点选和手填随时切换。默认不列隐藏项,需要时勾「显示隐藏项」。
- 文件夹单击进入(手机上也能用),文件单击选中、双击直接选用;连点同一项、
  以及刚跳转过后的 350ms 内忽略点击,双击文件夹不会连进两层。
- 选完只标记「未保存」并填进输入框,不自动保存,和文本框的规则保持一致。
- 补上 README 里的用法和 doc/webapi.md 里的接口说明。

新增 browse_test.go(12 个用例);仓库外的 verify_pick.py 30 项断言全过,
go test ./...、gofmt、go vet、构建均干净。
2026-09-25 16:30:01 +08:00

8.3 KiB
Raw Blame History

acfunlive web API

web API 默认本地端口为 51880

http://localhost:51880/listlive 列出正在直播的主播

http://localhost:51880/listrecord 列出正在下载的直播视频

http://localhost:51880/listdanmu 列出正在下载的直播弹幕

http://localhost:51880/liststreamer 列出设置了开播提醒或自动下载直播的主播

http://localhost:51880/startmirai 利用 Mirai 发送直播通知到指定 QQ 或 QQ 群

http://localhost:51880/addnotifyon/23682490 通知 uid 为 23682490 的主播的开播

http://localhost:51880/delnotifyon/23682490 取消通知 uid 为 23682490 的主播的开播

http://localhost:51880/addnotifyoff/23682490 通知 uid 为 23682490 的主播的下播

http://localhost:51880/delnotifyoff/23682490 取消通知 uid 为 23682490 的主播的下播

http://localhost:51880/addnotifyrecord/23682490 通知 uid 为 23682490 的主播的直播视频下载

http://localhost:51880/delnotifyrecord/23682490 取消通知 uid 为 23682490 的主播的直播视频下载

http://localhost:51880/addnotifydanmu/23682490 通知 uid 为 23682490 的主播的直播弹幕下载

http://localhost:51880/delnotifydanmu/23682490 取消通知 uid 为 23682490 的主播的直播弹幕下载

http://localhost:51880/addrecord/23682490 uid 为 23682490 的主播直播时自动下载其直播视频

http://localhost:51880/delrecord/23682490 取消自动下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/adddanmu/23682490 uid 为 23682490 的主播直播时自动下载其直播弹幕

http://localhost:51880/deldanmu/23682490 取消自动下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/addkeeponline/23682490 uid 为 23682490 的主播直播时在其直播间里挂机

http://localhost:51880/delkeeponline/23682490 取消设置在 uid 为 23682490 的主播直播时在其直播间里挂机

http://localhost:51880/delconfig/23682490 删除 uid 为 23682490 的主播的所有设置

http://localhost:51880/getdlurl/23682490 查看 uid 为 23682490 的主播是否在直播,并输出其直播源

http://localhost:51880/addqq/23682490/12345 将 uid 为 23682490 的主播的开播提醒发送到 QQ12345,需要 QQ 机器人已经添加该 QQ 为好友

http://localhost:51880/delqq/23682490/12345 取消将 uid 为 23682490 的主播的开播提醒发送到 QQ12345

http://localhost:51880/cancelqq/23682490 取消将 uid 为 23682490 的主播的开播提醒发送到任何 QQ

http://localhost:51880/addqqgroup/23682490/12345 将 uid 为 23682490 的主播的开播提醒发送到 QQ 群 12345,需要 QQ 机器人已经加入该 QQ 群,最好是管理员,会@全体成员

http://localhost:51880/delqqgroup/23682490/12345 取消将 uid 为 23682490 的主播的开播提醒发送到 QQ 群 12345

http://localhost:51880/cancelqqgroup/23682490 取消将 uid 为 23682490 的主播的开播提醒发送到任何 QQ 群

http://localhost:51880/startrecord/23682490 临时下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/stoprecord/23682490 取消下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/startdanmu/23682490 临时下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/stopdanmu/23682490 取消下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/startrecdan/23682490 临时下载 uid 为 23682490 的主播的直播视频和弹幕

http://localhost:51880/stoprecdan/23682490 取消下载 uid 为 23682490 的主播的直播视频和弹幕

http://localhost:51880/log 查看 log

http://localhost:51880/quit 退出 acfunlive 运行

http://localhost:51880/help 显示帮助信息

新版 web UI 的管理接口

web UI(-webui,端口看webPort)用的是另一套/api/接口,全部需要带管理口令:请求头X-Auth-Token: <口令>,或者在 URL 上带?token=<口令>(下载链接用后者,因为浏览器跳转带不了请求头)。

口令支持任意字符,包括中文——不过 HTTP 请求头只接受 ISO-8859-1,浏览器遇到非 ASCII 的口令会直接拒绝发请求(报String contains non ISO-8859-1 code point),所以页面发给服务端的X-Auth-Token是百分号编码过的口令(encodeURIComponent)。服务端两种写法都认:先拿原样比,再拿解码后的比,所以手写 curl 或者脚本按原样把中文口令放进请求头、Authorization: Bearer、?token= 里也都能通过。用脚本调这套接口时不用管编码,原样填就行。

跟手动合并有关的是下面两个: POST /api/merge/info 预览一次手动合并的计划,不落盘。

{
    "videos": ["2026-09-25 01-00-00 主播 标题.mp4", "D:/别处/随手放的视频.mp4"],
    "danmu": "2026-09-25 01-00-00 主播 标题.ass",
    "offset": 3                // 可选,不填按文件名里的录制时间推算
}

返回分段列表(名字、体积、时长、是否正在写入)、总时长、弹幕条数、弹幕时间范围、要用的弹幕文件和来源(jsonl 弹幕数据 / 同名的 jsonl 弹幕数据 / 由 xxx.ass 还原)、推算出的偏移和原因、最终输出文件名、以及提示(warnings)。参数不合法一律 400,并在响应体里给中文原因。

POST /api/merge 真正开始合并,请求体和上面一样,另外可以带outName指定输出文件名(不合法会被清理成安全的文件名,重名自动加后缀)。成功后立刻返回{"outName":"…"},合并在后台跑。已经有一个手动合并任务在跑时返回 409。

合并状态通过GET /api/status查看:mergeBusy(是否在跑)、mergeOutName(当前成片名)、mergeErr(失败原因)、mergeDoneAt(上次完成时间)。合并期间成片会出现在GET /api/files里且inUse为 true,此时POST /api/file/remove会返回 409 拒绝删除。

POST /api/notify/test 测试某个推送渠道能不能连通。用传进来的值直接测,留空的项自动用已保存的配置补齐,所以不用先保存设置。测试不受渠道开关和事件勾选影响。

// QQ 机器人(webhook)渠道,channel 不填就按这个
{ "channel": "qq", "url": "http://127.0.0.1:8080/acfunlive/notify", "token": "可选", "group": "可选" }
// MeoW 渠道
{ "channel": "meow", "nickname": "你的昵称", "msgType": "text", "imgUrl": "可选", "htmlHeight": 200 }

成功后返回{"ok":true,"detail":"webhook 返回 HTTP 200,用时 0.31 秒。…"},detail就是页面上显示的那句结论。失败时返回 502 并在响应体里给中文原因(如MeoW 返回 status 404(昵称未注册)),参数不合法返回 400。

MeoW 的status和封禁规则会反映在GET /api/status的meowBlocked字段里:昵称没填、格式不对、或已被 MeoW 判过「未注册」时,这里会给出中文原因,非空就说明 MeoW 渠道当前推不出去。注意 MeoW 一天内累计 3 次推给不存在的昵称会封 IP,所以被判过不存在的昵称会被程序记住并停止重试,改昵称或重启程序才恢复。

GET /api/browse 给页面上的浏览按钮列目录用。参数:path(要展开的目录,不填就用程序当前的工作目录)、kind=file(连文件一起列,挑文件时用)、hidden=1(连以点开头的隐藏项一起列)。

{
    "path": "D:\\record",                                     // 当前展开的目录,已转成绝对路径
    "parent": "D:\\",                                         // 上级目录,已经到根时是空串
    "roots": [{"name": "C:", "path": "C:\\", "dir": true, "size": 0}],
    "entries": [{"name": "2026-09-25.mp4", "path": "D:\\record\\2026-09-25.mp4", "dir": false, "size": 123}],
    "truncated": false,                                       // 条目太多时只返回前 2000 项
    "error": ""                                               // 打不开时的中文原因
}

文件夹排在文件前面,同类按名字排(不区分大小写)。挑文件时文件夹照样会列出来,不然进不去子目录。error非空时仍是 HTTP 200,entries是空的,但parent会带上——页面据此退到上一级,不会把用户卡在一个打不开的路径里(比如把文件路径当目录展开时)。

这个接口能看到整台机器的目录,但权限和其它管理接口一样,都是拿到口令即全部权限,没有放宽。