根据自定义场次UUID查询直播场次

接口描述

1、查询根据自定义场次UUID查询直播场次
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/session/list-session-by-external

请求方式

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	场次ID
externalSessionId	true	String	自定义直播场次UUID，该参数设置自【直播场次关联自定义ID】

示例

http://api.polyv.net/live/v3/channel/session/list-session-by-external?appId=fso8gzbxlr&timestamp=1636421147000&channelId=2659445&externalSessionId=binytest2021110802&sign=56933052D433EB34E9BA0F9DA5197728

响应参数描述

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

data字段描述

参数名	类型	说明
list	List< String >	场次ID

Java请求示例

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询角色信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testQuerySessionListByExternalSessionId() 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/list-session-by-external";
    String channelId="2149710";
    String externalSessionId= "test";
 
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("externalSessionId", externalSessionId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("根据自定义场次UUID查询直播场次，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "list": [
            "g41jb9hxbk",
            "g41ked2ck6",
            "g41k9buc96",
            "g41jwdl09l"
        ]
    }
}

异常示例

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