作品合成结果回调
1.接口说明
该接口由用户实现,用户提交的作品合成完成后,会请求该接口回调合成结果,仅回调结果。
接口地址由用户提供,有两种方式提供,一种是请求 https://digitbot.bokecc.com/api/project/compose 接口时,通过 callbackUrl 参数指定,此方式只对当前合成作品有效 。
另一种是联系客服,提供回调地址作为账号配置(后期会提供界面功能配置),此方式对用户所有作品生效,优先使用接口指定回调地址。
2.请求方式
GET
3.请求参数
(1).Query参数(UrlEncoded):通过URL参数传递。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| productId | String | 是 | 作品ID。 |
| result | Integer | 是 | 作品合成结果,枚举值。-1=内容违规;0=合成失败;1=合成成功。 |
| type | Integer | 是 | 作品类型,枚举值。0=视频;1=音频。 |
| name | String | 是 | 作品名称。 |
| projectId | String | 是 | 项目ID。 |
| projectName | String | 是 | 项目名称。 |
| videoWidth | Integer | 是 | 视频宽度,像素值。 |
| videoHeight | Integer | 是 | 视频高度,像素值。 |
| duration | Long | 否 | 作品时长,单位:毫秒,作品合成成功时返回 。 |
| expireDate | String | 否 | 作品过期日期,yyyy-MM-dd格式,作品合成成功时返回 。 |
| previewUrl | String | 否 | 作品预览链接,作品合成成功时返回 。 |
| memberId | String | 否 | memberId,iframe方式使用时用户指定的创作标识。 |
4.成功响应示例
{
"result": "OK"
}
5.响应说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| result | String | 回调请求成功响应结果,字符串"OK"不区分大小写。 |