上传点播视频字幕文件

接口URL

https://api.polyv.net/v2/video/{userId}/srt/upload

接口说明

上传点播视频字幕接口,改接口会自动检测字幕语言。

返回结果支持格式

form-data

请求方式

POST

请求参数

参数名 必选 类型及范围 说明
userId true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
vid true string 点播视频vid
title true string 字幕名称
file true file 字幕文件,支持utf-8编码
asDefault false string 是否作为默认字幕,Y:是,N:否
language false string 语言,默认自动检测,支持语言:中文、繁体中文 、英语、日语、韩语、法语、德语、俄语、西班牙语、阿拉伯语、葡萄牙语、其他

返回结果

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

失败返回json

// 时间戳过期:
{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}
// 文件名称为空
{
    "code": 400,
    "status": "error",
    "message": "title can't be empty",
    "data": ""
}
// 文件为空
{
    "code": 400,
    "status": "error",
    "message": "file can't be empty",
    "data": ""
}
// 签名报错
{
    "code": 400,
    "status": "error",
    "message": "the sign is not right.",
    "data": ""
}

响应参数说明

字段 说明 类型 schema
code 响应码 int32
status 响应状态:success/error/fail string
message 错误信息说明 string
data 响应数据

响应错误说明

错误代码 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. 签名不正确
400 vid can't be empty 视频vid为空
400 file can't be empty 视频文件不能为空
400 title can't be empty 标题为空
400 language is not support 不支持的语言

PHP请求示例

<?php

$userId="xxxxxx";
$secretkey="xxxxxx";
$url = 'http://api.polyv.net/v2/video/'.$userId.'/srt/upload';
$header = array('Content-type: multipart/form-data');
$data = array(
    "ptime" => time()*1000,
    "title" => "xxxxx",
    "vid" => "xxxxxx_x",
);
ksort($data);
$str='';
foreach ($data as $k => $v) {
    $str = $str.$k.'='.$v.'&';
}
$str=substr($str,0,strlen($str)-1);
$str=$str.$secretkey;
$hash=strtoupper(sha1($str));
$data["sign"]=$hash;
$data['file']='@/home/moshunwei/english.srt';
// 请求接口
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
$sResult = curl_exec($ch);
if($sError=curl_error($ch)){
    die($sError);
}
curl_close($ch);
//打印获得的数据
print_r($sResult);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

2、将请求参数按照参数名字典顺序排列

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

50BF9B165630A8047EB1D17D95A469CC51FF754E
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

合并字幕文件

接口URL

https://api.polyv.net/v2/video/${userId}/srt/merge

接口说明

接口用于合并字幕文件

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
vid true string 点播视频id
sourceSrtNames true string 原始字幕名称,必须传两个值。以英文逗号分隔,合并后第一个字幕的内容在上方显示。
mergedSrtName false string 合并字幕的名称,默认:双语。不超过5个中文字符。
setAsDefault false boolean 是否设置为默认显示的字幕。默认值:true。

返回结果

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

失败返回json(不带jsonp)

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

响应说明

错误代码 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. 加密串不正确
400 vid is blank 视频id为空
400 sourceSrtNames is error format 原始字幕名称格式错误,需要2个字幕名称,以英文逗号分隔
400 srt file limit 2 , now has 3 每个视频字幕上限为2个
400 not found srt name %s 原始字幕不存在

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$secretkey="用户secretKey";
$params = array(
    'ptime' => time()*1000,
    'userid' => $userid,
    'vid' => 'b0f70413249189c1c9a4d771fca3807a_b',
    'sourceSrtNames' => '1,2',
    'mergedSrtName' => '合并3',
    'setAsDefault' => 'true'
);

# 创建排序后的字典
foreach ($params as $key=>$value){
    $arr[$key] = $key;
}
sort($arr);
$str='';
$length=count($arr);
foreach ($arr as $k => $v) {
    $str = $str.$v.'='.$params[$v];
    if($k < $length-1) {
      $str = $str.'&';
    }
}
$hash=strtoupper(sha1($str.$secretkey));

$params['sign']=$hash;
$url="http://api.polyv.net/v2/video/${userid}/srt/merge?".http_build_query($params);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = curl_exec($ch);
curl_close($ch);
//打印获得的数据
print_r($output);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

2、将请求参数按照参数名字典顺序排列

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

50BF9B165630A8047EB1D17D95A469CC51FF754E
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

删除视频字幕

接口URL

https://api.polyv.net/v2/video/{userId}/srt/delete

接口说明

删除视频字幕。

返回结果支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
vid true string 视频ID,例如 e6b23c6f51938e173b8e573b881f7723_e
ranks true string 字幕序号列表,序号从1开始,多个以英文逗号分隔,例如 2,3

返回结果

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

失败返回json(不带jsonp)

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

响应说明

错误代码 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. 无效的视频字幕序号

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$vid="视频id";
$ranks="视频序号";
$ptime=time()*1000;//13位
$secretkey="填写secretkey";
$str="ptime=".$ptime."&ranks=".$ranks."&vid=".$vid.$secretkey;

$hash=strtoupper(sha1($str));
$url="https://api.polyv.net/v2/video/$userid/srt/delete?ptime=$ptime&sign=$hash&vid=$vid&ranks=$ranks";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$output = curl_exec($ch);
curl_close($ch);
print_r($output);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

ptime = "1492591990000"
ranks = "1"
vid = "8205ac89d30adeb51a6f8bf1a1df6f63_8"

2、将请求参数按照参数名字典顺序排列

ptime = "1492591990000"
ranks = "1"
vid = "8205ac89d30adeb51a6f8bf1a1df6f63_8"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

ptime=1492591990000&ranks=1&vid=8205ac89d30adeb51a6f8bf1a1df6f63_8tIQp4ATe9Z

4、生成签名sign

46E3C4C67DFF6E86C9ECCA9CDDFD52AC43AEA295
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取视频字幕

接口URL

https://api.polyv.net/v2/video/{userId}/srt/list

接口说明

获取视频字幕列表。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
vid true string 视频ID,例如 e6b23c6f51938e173b8e573b881f7723_e

返回结果

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "srts": [
            {
                "rank": 1,
                "name": "fantastic-tra"
            },
            {
                "rank": 2,
                "name": "fantastic-sim"
            }
        ]
    }
}

失败返回json(不带jsonp)

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

字段描述

字段 说明
rank 序号,从1开始
name 字幕名称

响应说明

错误代码 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. 找不到视频

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$vid="视频id";
$ptime=time()*1000;//13位
$secretkey="填写secretkey";
$str="ptime=".$ptime."&vid=".$vid.$secretkey;

$hash=strtoupper(sha1($str));
$url="https://api.polyv.net/v2/video/$userid/srt/list?ptime=$ptime&sign=$hash&vid=$vid";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$output = curl_exec($ch);
curl_close($ch);
//打印获得的数据
print_r($output);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

ptime = "1492591990000"
vid = "8205ac89d30adeb51a6f8bf1a1df6f63_8"

2、将请求参数按照参数名字典顺序排列

ptime = "1492591990000"
vid = "8205ac89d30adeb51a6f8bf1a1df6f63_8"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

ptime=1492591990000&vid=8205ac89d30adeb51a6f8bf1a1df6f63_8tIQp4ATe9Z

4、生成签名sign

7D0B965C4F4E9B2B4325AC098F29DAE2025C4F5C
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...