查询批量频道状态(旧版)

新版接口地址批量查询频道直播状态,强烈建议您使用新版接口

接口描述

1、批量查询频道直播状态
2、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channels/live-status

请求方式

POST

接口约束

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

2、该接口查询直播中的接收转播频道状态时,接口会返回end,建议您使用新版接口

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

channelIds

true

String

用英文逗号隔开的频道号,如:10000,100001 最多20个

示例

http://api.polyv.net/live/v2/channels/live-status

表单参数:

appId=frlr1zazn3&sign=19DAF4C4375B0352B0B9A37148C6E830&channelIds=2149813%2C2149710&timestamp=1621840930470

响应参数描述

参数名类型说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

Array

请求失败时为空,请求成功时为频道直播流状态信息【详见data字段说明

data字段说明

参数名类型说明

channelId

String

频道号

status

String

频道的直播状态 live:正在直播 end:未直播

seminarStatus

String

研讨会频道的研讨状态 seminar_live:正在研讨 seminar_end:暂无研讨

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
 * 批量查询频道直播流状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetLiveStatusList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channels/live-status";
    String channelIds = "2149813,2149710";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelIds", channelIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量查询频道直播状态,返回值:{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "channelId":2149710,
            "status":"end",
            "seminarStatus":"seminar_end"
        },
        {
            "channelId":2149813,
            "status":"live",
            "seminarStatus":"seminar_live"
        }
    ]
}

异常示例

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

Last updated