根據自訂場次UUID查詢直播場次

更新時間：2022-09-15 09:50:53

介面描述

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": ""
}