获取频道直播截图(新)

接口URL

http://api.polyv.net/live/v2/stream/{channelId}/capture

接口说明

1、截图功能,获取当前频道或子频道正在直播的截图(截图五分钟更新一次)
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data":"//livestatic.videocc.net/uploaded/images/2018/01/ex96has7bf.jpg"
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

子频道不存在

{
    "code": 400,
    "status": "error",
    "message": "account not exists.",
    "data": ""
}

频道不存在

{
    "code": 400,
    "status": "error",
    "message": "channel not exists.",
    "data": ""
}

子频道未直播

{
    "code": 400,
    "status": "error",
    "message": "account is not live.",
    "data": ""
}

频道未直播

{
    "code": 400,
    "status": "error",
    "message": "channel is not live.",
    "data": ""
}

获取图片失败

{
    "code": 400,
    "status": "error",
    "message": "get capture image failure.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求成功时截图地址,请求错误时为空

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "127075";

$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url

$url = "http://api.polyv.net/live/v2/stream/".$channelId."/capture?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign;

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

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