跳到主要内容

创建自定义视频背景

1.接口说明

用户除了可以使用图片背景外,也可以上传视频,创建自定义的视频背景,在项目中应用视频背景。

请求该接口,提供自定义视频背景素材信息,创建自定义视频背景,获取视频背景上传地址。

2.请求地址

https://digitbot.bokecc.com/api/background/video/custom/create

3.请求方式

POST application/json

4.请求参数

(1).公共参数,参考服务说明

(2).接口参数

①.Query参数:通过URL参数传递。

参数名类型必需说明
versionString接口版本号,当前支持版本:1.0.0。
projectIdString项目ID。

②.Body参数:通过请求Body传递,json格式。

参数名类型必需说明
filenameString视频文件名,最多100个字符,要求文件名带扩展名(后缀名)。目前仅支持mp4格式。
sizeLong视频大小,单位:B(字节)。视频背景总空间1GB,即所有视频背景的大小总和不能超过1GB。
md5String视频文件md5。

5.请求示例

POST https://digitbot.bokecc.com/api/background/video/custom/create?projectId=xxx&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
{
"filename": "四季.mp4",
"size": 123456700,
"md5": "xxxxxxxxxxxxxxxx"
}

6.响应示例

{
"id": "xxx",
"uploadUrl": "https://xxxx.xxxx/xxxx"
}

7.响应说明

字段名类型说明
idString背景ID。
uploadUrlString视频上传地址。
  • uploadUrl:使用该视频背景文件上传地址,以PUT方式,将视频文件数据发送到该地址即可。
    • 上传时需要注意设置Content-Type。
    • 该地址上传失败时,可以重新从头开始上传。
    • 上传成功后,该地址不再接收数据,不可重新上传。
    • 地址有效时间2小时。
    • 可参考上传示例。