创建视频大纲任务
更新时间:2024-08-27 11:37:16
接口描述
1、通过视频id,创建该视频的视频大纲分析任务,分析完成会以http回调的方式把分析结果回调回去,回调地址暂时请您联系保利威客服人员帮您配置
2、接口支持https协议
3、如果视频没有字幕, 会先自动使用保利威的智能字幕生成字幕, 并且生成的字幕会默认应用到该视频上
接口URL
http://api.polyv.net/vod/v4/video-outline/create
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
- URL参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 直播appId。可在"云点播" -> "设置" -> "API接口" 中查看您的直播appId和appSecret |
| timestamp | true | Long | 当前时间的毫秒级时间戳,30分钟内有效 |
| sign | true | String | 签名,32位大写MD5值【详见MD5签名生成规则】 |
- body参数(json)
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| vid | true | String | 视频id |
示例
https://api.polyv.net/vod/v4/video-outline/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353
参数:
{
"vid": "833u3s271d15dd452bf8393cfd5d4ac6_8"
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| requestId | String | 请求唯一标识,如遇接口调用失败情况,可发此id给客服辅助排查问题 |
| success | boolean | true代表接口调用成功,false代表接口调用失败 |
| data | Long | 成功返回视频大纲任务id,失败返回null。 |
| error | Object | 接口调用失败时的描述信息,【详见error字段说明】 |
error字段说明
返回错误代码列表
| code | desc | 说明 |
|---|---|---|
| 10002 | 签名错误 | 签名错误,请检查接口sign参数是否已经正常生成 |
| 10003 | 时间戳过期 | 时间戳过期 |
| 20003 | application not found. | appId不存在,清检查appId是否正确传值 |
响应示例
成功示例
{
"code": 200,
"status": "success",
"requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
"data": 50,
"success": true
}
异常示例
时间戳过期
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
签名错误
{
"code": 403,
"status": "error",
"error": {
"code": 10002,
"desc": "签名错误"
},
"success": false
}
