直播場次關聯自訂ID

更新時間：2022-12-15 10:04:04

介面說明

1、将直播场次关联自定义的直播场次UUID，关联频道之后开播的场次、以及这些开播场次衍生出来的裁剪和合并视频
3、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/session/relevance

請求方式

POST

介面限制

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，32位長度

範例

http://api.polyv.net/live/v3/channel/session/relevance?appId=frlr1zazn3&sign=863A72E3380FCB75F9C3C21677692B8D&externalSessionId=w11V61QWoK3332313778613940858739&channelId=2633655&timestamp=1636687112547

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求失敗時為空，請求成功時為true

Java請求範例

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);

/**
 * 直播场次关联自定义ID
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRelevanceSessions() 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/v3/channel/session/relevance";
    String channelId = "2633655";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("externalSessionId", super.getRandomString(32));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url,requestMap);
    String response = HttpUtil.postFormBody(url, null);
    log.info("直播场次关联自定义ID，返回值：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

異常範例

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