修改引導圖

更新時間：2022-11-30 18:51:06

介面描述

1、接口用于设置引导页开关以及引导图
2、接口URL中的{channelId}为频道号
3、（splashEnabled, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
4、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/setSplash

請求方式

POST

介面限制

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

2、開啟開關且之前未設定過引導圖，則上傳圖片不能為空。

3、引導圖要求：只能為jpg、jpeg、png三種格式，大小不能超過4Mb。

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
splashEnabled	true	String	設定開啟或關閉引導頁 Y：開啟 N：關閉
imgfile	false	File	支援jpg、jpeg、png三種格式，大小不能超過4Mb

範例

http://api.polyv.net/live/v2/channelSetting/1965681/setSplash

表單參數：

appId=frlr1zazn3&sign=59FA01DD41788BA25D8FE31827C30BD2&splashEnabled=Y&timestamp=1621840626094

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	請求成功時，如果上傳圖片則為圖片url，無上傳圖片則為"success"，請求失敗時返回空字串

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 testSetSplash() 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/setSplash","1965681");
    String splashEnabled = "Y";
    String path = getClass().getResource("/file/").getPath() + "dog.jpeg";
    File imgfile = new File(path);

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("splashEnabled",splashEnabled);
    Map<String, File> fileMap = new HashMap<>();
    fileMap.put("imgfile",imgfile);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url,requestMap,fileMap,"utf-8");
    log.info("测试修改引导图：{}",response);
    //do somethings
    
}

回應範例

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

成功範例

1、設定引導頁，未上傳圖片

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

2、設定引導頁，同時上傳圖片

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"//liveimages.videocc.net/uploaded/images/2021/03/fx0zmiovdd.jpeg"
}

異常範例

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