频道状态验证

接口描述

1、查询频道合法状态
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/status-valid

请求方式

GET

接口约束

1、接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值【详见签名生成规则】
channels	true	String	频道号，多个使用英文逗号分开，最多100个，例如：100000,100001

示例

http://api.polyv.net/live/v4/channel/status-valid?channels=1965681%2C2272665%2C3297504&appId=frlr1zazn3&sign=F8BDEF93ED3CD6EDEEFB399187D97582&timestamp=1662083490979

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

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

data参数描述

参数名	类型	说明
channels	Array	频道列表【详见channels字段描述】

channels参数描述

参数名	类型	说明
channelId	Integer	频道号
delete	Integer	频道是否已删除 1：已删除 0：未删除
currentUser	Integer	是否属于当前用户 1：是 0：否

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(GroupTestLive.class);
/**
 * 频道状态验证
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelStatusValid() 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/v4/channel/status-valid";
    String channels = "1965681,2272665,3297504";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channels", channels);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试频道状态验证，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "522451e702a4454dbb1a972abd4d4b71.62.16618407903140831",
    "data": {
        "channels": [
            {
                "channelId": 1965681,
                "delete": 0,
                "currentUser": 1
            },
            {
                "channelId": 2272665,
                "delete": 1,
                "currentUser": 0
            },
            {
                "channelId": 3297504,
                "delete": 1,
                "currentUser": 1
            }
        ]
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}