创建智能字幕任务
更新时间：2024-09-03 16:44:09
接口描述
1、通过视频id，创建该视频的字幕任务，自动为该视频生成一份字幕文件，字幕文件可通过接口查询，或在点播后台智能字幕模块中使用。详见：[智能字幕](/vod/product/manual/manage/video_subtitle)
2、接口支持https协议
接口URL
http://api.polyv.net/vod/v4/smart-subtitle/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 |
| autoApplyEnabled | false | String | 是否在字幕生成后自动应用字幕到对应的视频上, 参数值为Y或者N, Y代表自动应用字幕, N或者不传该参数代表不自动应用字幕 |
| language | false | String | 如果不传或者传了不支持的语言会默认当成chinese(中文)处理【详见language字段说明】 |
| repetitionEnabled | false | String | 是否允许重复任务, Y-允许，N-不允许, 默认Y |
language字段说明
| 参数值 | 语言 |
|---|---|
| chinese | 中文 |
| chinese_english_cantonese | 中英粤 |
| chinese_medical | 中文医疗 |
| cantonese | 粤语 |
| english | 英语 |
| japanese | 日语 |
| korean | 韩语 |
| vietnamese | 越南 |
| malay | 马来语 |
| indonesian | 印尼 |
| filipino | 菲律宾语 |
| thai | 泰文 |
| portuguese | 葡萄牙语 |
| turkish | 土耳其 |
| arabic | 阿拉伯语 |
| spanish | 西班牙语 |
| spanish | 西班牙语 |
示例
https://api.polyv.net/vod/v4/smart-subtitle/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353
参数：
{
"vid": "833u3s271d15dd452bf8393cfd5d4ac6_8",
"language": "chinese",
"autoApplyEnabled": "Y"
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码，200为成功返回，非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| requestId | String | 请求唯一标识，如遇接口调用失败情况，可发此id给客服辅助排查问题 |
| success | boolean | true代表接口调用成功，false代表接口调用失败 |
| data | Long | 成功返回字幕任务id，失败返回null。待字幕生成后可根据此字幕任务id查询字幕文件链接和字幕数据 |
| error | Object | 接口调用失败时的描述信息，【详见error字段说明】 |
error字段说明
返回错误代码列表
| code | desc | 说明 |
|---|---|---|
| 10002 | 签名错误 | 签名错误，请检查接口sign参数是否已经正常生成 |
| 10003 | 时间戳过期 | 时间戳过期 |
| 20003 | application not found. | appId不存在，清检查appId是否正确传值 |
| 56800 | 非法VID | 视频不存在；视频状态不正确（非已发布状态）；视频时长超过5小时 |
| 56809 | 资源或余额不足 | 资源或余额不足，请充值后再使用 |
响应示例
成功示例
{
"code": 200,
"status": "success",
"requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
"data": 1000,
"success": true
}
异常示例
时间戳过期
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
签名错误
{
"code": 403,
"status": "error",
"error": {
"code": 10002,
"desc": "签名错误"
},
"success": false
}
