删除字幕文件

接口描述

1、通过视频id删除视频字幕文件
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

接口URL

http://api.polyv.net/v2/video/{userid}/srt/delete

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名
必选
类型
说明

userid

true

String

保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口)

ptime

true

Long

当前时间的毫秒级时间戳,3分钟内有效

sign

true

String

签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

vid

true

String

视频id,例如:1b448be3235552e5fafb16489eb01839_1

ranks

true

string

该值可参考【查询字幕列表】字幕文件上传序号列表,序号从1开始,多个以英文逗号分隔,例如 2,3

示例

http://api.polyv.net/v2/video/1b448be323/srt/delete

表单参数:

vid=1b448be323dec2a7bed6db61bd7d8a77_1&ranks=1&sign=CB0C11F82F14F5515E950B10F3C25B65C69FD402&ptime=1617263469183

响应参数描述

参数名
类型
说明

code

Integer

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

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

响应成功时返回{},响应失败时返回空

返回错误代码列表

错误代码
message
说明

400

sign can not be empty.

加密串为空

400

ptime is too old.

时间戳过期

400

ptime is illegal.

时间戳参数格式不对或者超过当前时间3分钟

400

Could not find user by userid.

userid 不存在

400

the sign is not right.

加密串不正确

401

vid is blank.

vid 为空

401

ranks is blank.

ranks 为空

402

cannot find the video.

找不到视频

402

invalid srt ranks.

无效的视频字幕序号

Java请求示例

HttpUtil.java 和 VodSignUtil.java 基础代码请点击下载本地 或跳转到基础代码在线获取

private static final Logger log = LoggerFactory.getLogger(VodVideoSubtitleTest.class);
/**
 * 删除字幕
 */
@Test
public void testDeleteSubtitle() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/%s/srt/delete",userid);
    String vid =  "1b448be3230fa05b4d2d0003bf5a8ad0_1";
    String ranks = "1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("ranks",ranks);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试删除字幕,{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"message": "success",
	"data": {}
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}

Last updated

Was this helpful?