修改直播倒數計時設定

更新時間：2022-09-02 18:08:07

介面描述

1、接口用于修改频道的倒计时设置
2、接口URL中的{channelId}为频道号
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-countdown

線上API呼叫

請求方式

POST

介面限制

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

2、預約功能開啟需設定正確的直播時間才生效

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
bookingEnabled	false	String	預約觀看開關，Y或N，預設不改變原來狀態 Y：開啟 N：關閉
startTime	false	String	直播開始時間，如果不傳該值，表示不顯示直播時間和倒數計時，格式：yyyy-MM-dd HH:mm:ss

範例

http://api.polyv.net/live/v2/channelSetting/1958888/set-countdown

表單參數：

bookingEnabled=Y&appId=frlr1zazn3&sign=A4B3677AD1F0675FB792A50E3B20D7AB&startTime=2021-3-15+15%3A01%3A00&timestamp=1621840695352

回應參數描述

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

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WebInfoTest.class);
/**
 * 修改直播倒计时设置
 * @throws IOException
 */
@Test
public void testSetCountdown() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/set-countdown", "1958888");
    String bookingEnabled = "Y";
    String startTime = "2021-3-15 15:01:00";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("bookingEnabled",bookingEnabled);
    requestMap.put("startTime",startTime);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试修改直播倒计时设置：{}",response);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

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