视频进度回调
# 说明
当视频生成成功时(进度100%时),可以使用指定回调接口接收生成结果
- 回调节点:立即、10s、20s,直至接收方返回正确的报文表示推送成功
- 配置方式:1,通过创建视频任务入参
notifyUrl
传入动态回调地址
2,提前告知万木方一个固定地址 优先级为:创建任务入参>提前配置 - 响应方式:接入方应按在规定时间范围内按指定报文相应,否则会按回调失败处理
# 请求(post)
url由接入方定义
# 回调内容(json字符串形式,需以字符串类型接收后反序列化)
参数 | 类型 | 说明 |
---|---|---|
taskId | string | 本次生成任务的ID |
progress | int | 生成进度,0-100,100时表示生成成功,会携带视频信息返回 |
videoUrl | string | 视频地址,一般为mp4格式,来自万木健康OSS 由于防盗链策略,请在项目上线前提前告知万木方访问域名(即在哪个域名下展示该视频) 生产环境资源示例:https://static.prod.vanmul.com/north/vanmulhealth/2023-07-26/1684198881194987520.mp4 如果能顺利通过指定域名访问,即表示防盗链配置成功。封面图片同理 |
videoCover | string | 视频封面,一般为jpg格式,来自万木健康OSS 由于防盗链策略,请在项目上线前提前告知万木方访问域名(即在哪个域名下展示该封面图) |
duration | int | 视频时长,单位:毫秒 |
videoAlphaUrl | string | 绿幕视频支持alpha通道视频输出 |
subtitle | string | 字幕文件,ASS格式 |
customizedCover | string | 定制封面图,由接入方提前与万木沟通确认设计方案,格式同videoCover |
sign | string | 本次回调签名 |
# 签名方式
将appId和appSecret混入报文,并按key值正序排列,再按顺序对value进行SHA1加密
注意:随着平台服务能力提升,返回字段列表将不断扩充。请勿硬编码签名的key列表。
例如:回调正文为
{
"progress": 100,
"taskId": "asdfasdf",
"duration": 5520,
"videoUrl": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.mp4",
"videoCover": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpg",
"customizedCover": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpg",
}
混入appId和appSecret
{
"appId": "KFJDKF",
"appSecret": "SOVXCIF",
"progress": 100,
"taskId": "asdfasdf",
"duration": 5520,
"videoUrl": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.mp4",
"videoCover": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpg"
}
按key值排序后为
{
"appId": "KFJDKF",
"appSecret": "SOVXCIF",
"duration": 5520,
"progress": 100,
"taskId": "asdfasdf",
"videoCover": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpg",
"videoUrl": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.mp4"
}
则签名内容为:
string sign = SHA1("KFJDKFSOVXCIF5520100asdfasdfhttp://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpghttp://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.mp4")
签名后得到最终回调内容,将以字符串方式放置于request body中:
{
"duration": 5520,
"videoUrl": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.mp4",
"videoCover": "http://static.vanmul.com/north/vanmulhealth/2023-07-26/1684200158268280832.jpg",
"sign": "f0df4be95aa6c32440cbd5e52d758c5bd2348ac2",
"progress": 100,
"taskId": "asdfasdf"
}
# 向万木返回报文
http status: 200
body :ok
# 其他
由于网络或其他意外情况,建议配合查看任务进度
接口轮训使用,以保证正确获取生成结果(即进度)
上次更新: 2024/09/23, 15:33:43