录制任务启动文档.md
2.8 KB
高光录制调用说明
服务地址:http://47.93.239.64:3001
1. 录制单个课堂的全部高光时刻
调用:
POST /recordingTaskV2
Content-Type: application/json
请求示例(xdyui2 站点、课堂号 1010945096、2026-08-11):
curl -X POST 'http://47.93.239.64:3001/recordingTaskV2' \
-H 'Content-Type: application/json' \
--data '{
"list": [
{
"siteId": "xdyui2",
"classId": "1010945096",
"beginTime": "2026-08-11 00:00:00",
"endTime": "2026-08-11 23:59:59",
"onlyHighlight": 1
}
]
}'
要点:
-
onlyHighlight必须为1;否则会按整课堂录制。 -
classId是课堂号,也可以改传兼容字段meetingNumber。 -
beginTime、endTime建议传入课堂所在日期的北京时间范围;也支持 13 位毫秒时间戳。 - 返回
code="0"且accepted=1表示任务已接收,录制和上传仍在后台异步执行。
查询最终文件:
curl -X POST 'http://47.93.239.64:3001/fileExistsV2' \
-H 'Content-Type: application/json' \
--data '{
"siteId": "xdyui2",
"classId": "1010945096",
"onlyHighlight": 1
}'
当返回 fileExists=true 时,files 数组中的 url 就是该课堂各段高光 MP4 的下载地址。返回 fileExists=false 表示仍在录制或上传,可稍后重试查询。
2. 录制前一天某个站点的全部高光时刻课堂
指定一个站点立即执行
调用:
POST /highlight/recording/by-site
Content-Type: application/json
请求中的 beginTime、endTime 必须是“北京时间前一天 00:00:00.000 至 23:59:59.999”对应的 13 位毫秒时间戳。
例如在 2026-08-13 执行,录制 xdyui2 站点 2026-08-12 全天的高光:
curl -X POST 'http://47.93.239.64:3001/highlight/recording/by-site' \
-H 'Content-Type: application/json' \
--data '{
"siteId": "xdyui2",
"beginTime": 1786464000000,
"endTime": 1786550399999
}'
成功响应中的字段含义:
-
received:前一天该站点命中的高光总数。 -
queued、recording:等待或正在录制的数量。 -
uploading:本地 MP4 已生成,等待上传。 -
generated:最终文件已经生成。 -
invalid、failed:无效或失败的数量。
每天自动执行
先把目标站点放入服务器 HIGHLIGHTCONFIG.siteIds,例如只处理 xdyui2:
{
"HIGHLIGHTCONFIG": {
"siteIds": ["xdyui2"]
}
}
然后每天调用:
curl -X POST 'http://47.93.239.64:3001/highlight/recording/scheduled' \
-H 'Content-Type: application/json' \
--data '{}'
该接口会自动按北京时间计算前一天的完整时间范围,并录制 siteIds 中所有站点的全部高光;请求中不用再传日期。