添加指定时间点截图任务

接口URL

https://api.polyv.net/v2/video/snapshot/{userid}/addTask

接口说明

接口用于添加时间点截图任务,每个任务允许截图20张

支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
vid true string 视频vid
offsetTimes true string 截图时间点,多个时间点以英文逗号分隔
width false int 截图的宽度,默认为原视频宽
height false int 截图的高度,默认为原视频高
callbackUrl false string 截图完成后的回调地址,截图任务完成会post结果信息和签名到回调的地址,若地址返回的Http状态码为200,则会视为回调成功

返回结果

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

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
data 任务id

回调示例

如设置了callbackUrl,值为http://example.polyv.net/snapshot-callback.do
那么截图任务完成后,polyv会回调该接口,并带上签名信息,开发者可以通过签名信息来校验调用是否为polyv的合法调用,具体的签名规则:md5("snapshot" + vid + secretKey) 。如vid="e6b23c6f51350f106556806a576b1942_e",secretKey="testKey",那么sign="3adb60893894d422d00ed2efae8c41f3" (小写md5)。最终回调的url为http://example.polyv.net/snapshot-callback.do?sign=3adb60893894d422d00ed2efae8c41f3

任务成功回调json

{
    "taskId": 123,
    "vid": "e6b23c6f51350f106556806a576b1942_e",
    "status": "success",
    "snapshots": [
        {
            "offsetTime": 12,
            "imageUrl": "http://vod-assets.videocc.net/snapshot/e6b23c6f51/e6b23c6f519df1d317cca208edd448cb/12.jpg"
        },
        {
            "offsetTime": 78,
            "imageUrl": "http://vod-assets.videocc.net/snapshot/e6b23c6f51/e6b23c6f519df1d317cca208edd448cb/78.jpg"
        }
    ]
}

任务失败回调json

{
    "taskId": 123,
    "vid": "e6b23c6f51350f106556806a576b1942_e",
    "status": "fail",
    "snapshots": []
}

回调字段说明

字段名称 描述
taskId 任务id
status 任务状态,成功为success,失败为fail
vid 视频id
snapshots 成功为截图信息数组,失败为空数组
offsetTime 截图时间点,单位秒
imageUrl 截图的访问地址

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 vid invalid. 视频vid错误
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 audio limited 音频文件不允许截图
400 illegal video status 非转码中,待审核,已发布的状态,不允许截图
400 video not found 视频不存在
400 illegal offsetTimes 截图时间点为空
400 offsetTimes contain illegal number 截图时间点包含非法数值
400 offsetTime over duration 截图时间点超过了视频的时长
400 width over limit 宽度超过了原视频宽
400 height over limit 高度超过了原视频高
400 snapshot num limit 单个任务截图张数超过上限

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$secretkey="用户secretkey";
$params = array(
    'ptime' => time()*1000,
    'vid' => '视频vid',
    'offsetTimes' => '5,4,8',
    'width' => 100,
    'height' => 100
);

# 创建排序后的字典
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/snapshot/${userid}/addTask?".http_build_query($params);
$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"
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...