Create Video Outline Task

Updated: 2024-08-27 11:37:16

1、通过视频id，创建该视频的视频大纲分析任务，分析完成会以http回调的方式把分析结果回调回去，回调地址暂时请您联系保利威客服人员帮您配置
2、接口支持https协议
3、如果视频没有字幕, 会先自动使用保利威的智能字幕生成字幕, 并且生成的字幕会默认应用到该视频上

http://api.polyv.net/vod/v4/video-outline/create

POST

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Parameter	Required	Type	Description
appId	true	String	Live streaming appId. You can view your live streaming appId and appSecret in "Cloud VOD" -> "Settings" -> "API Interface".
timestamp	true	Long	Current time in milliseconds, valid within 30 minutes.
sign	true	String	Signature, 32-character uppercase MD5 value. See MD5 signature generation rules

Parameter	Required	Type	Description
vid	true	String	Video ID

https://api.polyv.net/vod/v4/video-outline/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353

Parameters:

{
    "vid": "833u3s271d15dd452bf8393cfd5d4ac6_8"
}

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	Response status text.
requestId	String	Unique request identifier. If an API call fails, provide this ID to customer support for troubleshooting.
success	boolean	true indicates the API call succeeded, false indicates failure.
data	Long	Returns the video outline task ID on success, returns null on failure.
error	Object	Error description when the API call fails. See error field description

Parameter	Type	Description
code	Integer	Error code. See return error code list
desc	String	Error description. See return error code list

code	desc	Description
10002	Signature error	Signature error. Check if the interface sign parameter is correctly generated.
10003	Timestamp expired	Timestamp expired.
20003	application not found.	appId does not exist. Check if the appId value is correct.

Success Example

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

Error Example

Timestamp Expired

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

Signature Error

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

VOD Server API