导出频道场次报表(图表)

接口描述

1、导出频道场次报表(图表)
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/session/stats/export

请求方式

GET

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

channelId

true

String

直播频道号

sessionId

true

String

直播场次号

示例

http://api.polyv.net/live/v3/channel/session/stats/export?appId=fso8gzbxlr&timestamp=1636421147000&channelId=2659445&sessionId=sisssssdfd&sign=56933052D433EB34E9BA0F9DA5197728

响应参数描述

参数名类型说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

String

直播场次报表的下载地址(地址的有效期是60天,过期后要重新调用接口生成)

Java请求示例

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 导出频道场次报表(画图表)
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testExportChannelSessionIdStats() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/session/stats/export";
    String channelId="2149710";
    String sessionId= "test";
 
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("导出直播场次报表,返回值:{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "https://liveimages.videocc.net/xx/xxx/xx.xlsx"
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "Report is not ready yet, please try again later.",
    "data": ""
}

Last updated