保利威文档中心

帮助中心

点播服务器 API

查询字幕列表

更新时间：2025-01-14 15:55:43

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名 必选 类型 说明
ptime true Long 当前时间的毫秒级时间戳，3分钟内有效
sign true String 签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
vid true String 视频id，例如：1b448be3235552e5fafb16489eb01839_1

示例

http://api.polyv.net/v2/video/1b448be323/srt/list?vid=1b448be323dec2a7bed6db61bd7d8a77_1&sign=0A3134D4A830F7F75EB13AFDC11FE91596B333CF&ptime=1617263522491

响应参数描述

参数名 类型 说明
code Integer 响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status String 响应状态文本信息
message String 响应描述信息，当code为400或者500的时候，辅助描述错误原因
data Object 成功返回字幕文件信息【详见Data字段说明】，响应失败时返回空
Data参数描述
参数名 类型 说明
srts Array 响应结果集【详见Srts字段说明】
Srts参数描述
参数名 类型 说明
rank Integer 字幕文件上传序号，从1开始
name String 字幕文件名称
url 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为空
402 cannot find the video. 找不到视频

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodVideoSubtitleTest.class);
/**
 * 查询字幕列表
 */
@Test
public void testGetSubtitle() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/video/"+userid+"/srt/list";
    String vid =  "1b448be323dec2a7bed6db61bd7d8a77_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询字幕列表，{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "srts": [{
            "rank": 1,
            "name": "测试字幕",
            "url": "http://img.videocc.net/usrt/1/1b448be323/srt/9b6d1f68-c5e7-4a90-af1c-72ea23ab0a9c.srt"
        }]
    }
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}
联系客服，在线咨询