视频创作回调通知

作用

用户发起任务后，服务端会对客户所设置的接口地址，以POST方式提交任务处理情况到用户自定义的回调接口。

回调失败重试

• 接口如果没有返回 http status 200 状态码, 会认为用户处理本次回调失败，针对失败的情况, 会重试3次回调

回调参数说明

提交制课任务回调

• 请求方式: POST

URL参数

BODY参数:

回调数据示例

请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f&timestamp=1701964858687

请求体(body参数: application/json)示例

{
  "existDigitalHuman": true,
  "fileName": "智能制课测试PPT.pptx",
  "videoName": "智能制课测试PPT",
  "id": 1000,
  "status": "WAITING",
  "childUserInfo": {
    "userId": "abc483974343",
    "email": "xxx-child-user@qq.com",
    "name": "张三",
    "organizationId": 1001
  },
  "subtitleInfo": {
    "enableSubtitle": "true"
  }
}

制课成功回调

• 请求方式: POST

URL参数

BODY参数:

回调数据示例

请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f&timestamp=1701964858687

请求体(body参数: application/json)示例

{
  "existDigitalHuman": true,
  "videoPath": "https://oss-live-1.videocc.net/pptvideo/20231207/video/1000_5a8eaaceb8c58ef8c872c7dah8db71eb5453dbe25b5pptVideocommon.mp4",
  "audioPath": "https://oss-live-1.videocc.net/pptvideo/20231207/video/1000_5a8eaaceb8c58ef8c872c7dah8db71eb5453dbe25b5pptVideocommon.mp3",
  "fileName": "智能制课测试PPT.pptx",
  "videoFileSize": 1025386,
  "dealTime": "2023-12-05 14:30:30",
  "videoName": "智能制课测试PPT",
  "videoImage": "https://oss-live-1.videocc.net/pptvideo/20231207/image/1000_5a8eaaceb8c58ef8c872c7dah8db71eb5453dbe25b5pptVideocommon.jpeg",
  "videoDuration": 62,
  "id": 1000,
  "status": "SUCCESS",
  "childUserInfo": {
    "userId": "abc483974343",
    "email": "xxx-child-user@qq.com",
    "name": "张三",
    "organizationId": 1001
  },
  "subtitleInfo": {
    "enableSubtitle": "true",
    "subtitlePath": "http://example.com/xxx/xxx/abc.srt"
  }
}

制课失败回调

当视频创作任务最终进入失败状态时触发。对于同一个任务，仅首次由非失败状态进入失败状态时发送回调，重复更新失败状态不会重复发送。

• 请求方式: POST

URL参数

BODY参数:

回调数据示例

请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f&timestamp=1701964858687

请求体(body参数: application/json)示例

{
  "id": 1000,
  "videoName": "智能制课测试PPT",
  "videoPath": null,
  "audioPath": null,
  "videoFileSize": null,
  "videoDuration": null,
  "videoImage": null,
  "fileId": "abc123456",
  "fileName": "智能制课测试PPT.pptx",
  "dealTime": null,
  "existDigitalHuman": "true",
  "status": "FAIL",
  "source": "VIDEO_PRODUCE",
  "errorMessage": "素材文件为空",
  "accountUserInfo": {
    "userId": "abc483974343",
    "email": "xxx@qq.com"
  },
  "childUserInfo": null,
  "subtitleInfo": {
    "enableSubtitle": true,
    "subtitlePath": null
  }
}

删除制课任务回调

• 请求方式: POST

URL参数

BODY参数:

回调数据示例

请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f&timestamp=1701964858687

请求体(body参数: application/json)示例

{
  "existDigitalHuman": true,
  "videoPath": "https://oss-live-1.videocc.net/pptvideo/20231207/video/1000_5a8eaaceb8c58ef8c872c7dah8db71eb5453dbe25b5pptVideocommon.mp4",
  "fileName": "智能制课测试PPT.pptx",
  "dealTime": "2023-12-05 14:30:30",
  "videoName": "智能制课测试PPT",
  "videoImage": "https://oss-live-1.videocc.net/pptvideo/20231207/image/1000_5a8eaaceb8c58ef8c872c7dah8db71eb5453dbe25b5pptVideocommon.jpeg",
  "id": 1000,
  "status": "DELETE",
  "childUserInfo": null
}

accountUserInfo字段说明

childUserInfo字段说明

字幕信息字段说明

成功保存制课任务草稿回调

• 请求方式: POST

URL参数

BODY参数:

回调数据示例

请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f&timestamp=1701964858687

请求体(body参数: application/json)示例

{
  "existDigitalHuman": true,
  "fileId": "2c38b75fc16a1dee3822950fa817d477915c3aad3apptVideocommon",
  "fileName": "智能制课测试PPT.pptx",
  "videoName": "智能制课测试PPT",
  "id": 1000,
  "clientIp": "183.22.1.33",
  "status": "DRAFT"
}

未选择或未传入PPT时，fileId和fileName字段仍会返回，字段值为空字符串：

{
  "existDigitalHuman": true,
  "fileId": "",
  "fileName": "",
  "videoName": "智能制课测试PPT",
  "id": 1000,
  "clientIp": "183.22.1.33",
  "status": "DRAFT"
}

如何设置

通过后台设置：

登录账户 - 进入【云直播】 - 点击【开发设置】- 点击【回调设置】- 视频创作信息回调

注意：提交的接口地址必须要以 http:// 或者 https:// 开头