更新智能字幕内容

接口描述

1、更新智能字幕生成的字幕内容(需先创建字幕任务)
2、接口支持https协议

接口URL

http://api.polyv.net/vod/v4/smart-subtitle/update

请求方式

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)

参数名必选类型说明

taskId

true

String

字幕任务id,创建字幕任务时会返回此id

autoApplyEnabled

false

String

是否在修改完字幕内容后自动发布该字幕,Y表示自动发布,N则相反。如果不传此参数, 会读取当前字幕任务预先配置的值

subtitleName

false

String

字幕标题,长度限制20个字符。如果不传此参数,会读取当前字幕任务预先配置的值

preferenceEnabled

false

String

字幕发布后,视频是否默认首选当前字幕。Y表示默认首选,字幕发布后会对应的视频会优先使用当前字幕,N则相反。如果不传此参数,会读取当前字幕任务预先配置的值

subtitles

true

List

【详见data字段说明

字幕内容字段说明

参数名类型说明

start

Long

单条字幕相对视频播放的开始时间,单位是毫秒

end

Long

单条字幕相对视频播放的结束时间,单位是毫秒

content

String

单条字幕的内容

示例

https://api.polyv.net/vod/v4/smart-subtitle/update?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353

参数:

{
    "taskId": 1000,
    "autoApplyEnabled": "Y",
    "subtitleName": "智能字幕",
    "preferenceEnabled": "Y",
    "subtitles": [
        {
            "start": 0,
            "end": 1130,
            "content": "今天,"
        },
        {
            "start": 1210,
            "end": 4340,
            "content": "当我们想在生活中学习一些新知识的时候,"
        },
        {
            "start": 4630,
            "end": 8270,
            "content": "大部分人想到的是去搜索对应的视频教程,"
        },
        {
            "start": 8980,
            "end": 13700,
            "content": "同时越来越多的企业也正在尝试使用视频进行培训。"
        }
    ]
}

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

requestId

String

请求唯一标识,如遇接口调用失败情况,可发此id给客服辅助排查问题

success

boolean

true代表接口调用成功,false代表接口调用失败

data

boolean

true代表接口调用成功,false代表接口调用失败

error

Object

接口调用失败时的描述信息,【详见error字段说明

error字段说明

参数名类型说明

code

Integer

错误码 【详见返回错误代码列表

desc

String

错误描述 【详见返回错误代码列表

返回错误代码列表

codedesc说明

10002

签名错误

签名错误,请检查接口sign参数是否已经正常生成

10003

时间戳过期

时间戳过期

20003

application not found.

appId不存在,清检查appId是否正确传值

56806

文件上传失败

服务端保存字幕文件时失败

56810

字幕任务不存在或已删除

字幕任务不存在或已删除

56811

智能字幕任务状态异常

常见于字幕任务尚未初次解析完,就执行更新字幕操作。或对创建异常的字幕任务执行更新操作

响应示例

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "f813d5d2359743028b6648e54ade1bf1.61.16801654871580495",
    "data": true,
    "success": true
}

异常示例

时间戳过期

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}

签名错误

{
    "code": 403,
    "status": "error",
    "error": {
        "code": 10002,
        "desc": "签名错误"
    },
    "success": false
}

字幕任务不存在或已删除

{
    "code": 400,
    "status": "error",
    "requestId": "f813d5d2359743028b6648e54ade1bf1.58.16801655508460503",
    "error": {
        "code": 56810,
        "desc": "字幕任务不存在或已删除"
    },
    "data": null,
    "success": false
}

Last updated