查詢頻道回放設定

單獨查詢回放開關可使用舊版介面，介面位址查詢頻道回放開關

介面描述

1、查询频道回放设置
2、接口支持https协议

介面URL

https://api.polyv.net/live/v3/channel/playback/get-setting

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

範例

http://api.polyv.net/live/v3/channel/playback/get-setting?appId=frlr1zazn3&sign=9DC1D9A3AAD34E0DD5C3B3154F1A6F5D&channelId=3187786&timestamp=1655964947987

回應參數描述

Data參數描述

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询频道回放设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlaybackSetting() 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/playback/get-setting";
    String channelId = "3187786";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道回放设置，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 3187786,
        "type": "single",
        "origin": "record",
        "videoId": null,
        "playbackEnabled": "Y",
        "videoName": null,
        "sectionEnabled": "Y",
        "globalSettingEnabled": "N",
        "chatPlaybackEnabled": "N",
        "crontabType":"period",
        "startTime": 1694102400000,
        "endTime": 1695398400000,
        "productPlaybackEnabled": null,
        "customOpenDuration": 18,
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "Y",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "Y",
        "questionnairePlaybackEnabled": "N",
        "qaPlaybackEnabled": "N",
        "cardPushPlaybackEnabled": "N",
        "checkInPlaybackEnabled": "N"
    }
}

異常範例

參數錯誤

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": 400
}

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

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

簽名錯誤

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