查询频道的直播推流信息

接口描述

1、查询频道的直播推流信息
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/monitor/list-tencent-stream-info

在线API调用

请求方式

GET

接口约束

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

2、仅支持腾讯cdn的频道

3、仅支持状态为直播中的频道

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
channelId	true	String	频道号
startTime	false	String	开始时间，默认为3小时前
endTime	false	String	结束时间，默认为当前时间，支持查询最近7天数据
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】

示例

https://api.polyv.net/live/v3/channel/monitor/list-tencent-stream-info?appId=frlr1zazn3&timestamp=1680831521000&sign=7B95CA869B5D121181FE3586ACBF10BA&channelId=3880533

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	响应成功时返回回放视频列表信息【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Data参数描述

参数名	类型	说明
streamUrl	String	推流路径
bitRate	Integer	视频码率，单位: bps
audioFrameRate	Integer	音频帧率
videoFrameRate	Integer	视频帧率
time	Array	数据时间，格式: %Y-%m-%d %H:%M:%S.%ms，精确到毫秒级

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 获取腾讯cdn频道的直播实时推流信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetTxStreamInfo() 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/monitor/list-tencent-stream-info";
    String channelId="3880533";
    String startTime = "1680749400000";
    String endTime="1680759580000";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试获取腾讯cdn频道的直播实时推流信息，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "streamUrl": "recordf",
            "bitRate": "1157120",
            "audioFrameRate": "46",
            "videoFrameRate": "13",
            "time": "2023-04-07 09:45:24.443",
            "timestamp": null
        }
    ]
}

异常示例

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

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