取得頻道的皮膚設定資訊介面

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

介面URL

https://api.polyv.net/live/v3/channel/theme/get

介面說明

1、接口用于获取频道的皮肤设置信息
2、接口支持https

回傳結果格式

JSON

請求方式

GET

請求參數

參數名	必選	類型	說明
appId	是	string	從API設定中取得，在直播系統登記的appId
timestamp	是	long	13位當前時間戳
sign	是	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	是	int	頻道號

回應成功JSON範例：

{
"code": 200,
"status": "success",
"message": "",
"data": {
    "pageSkin": "green",
    "watchLayout": "video",
    "watchTemplateType": "new",
    "scene": "ppt",
    "mobileWatchLayout": "normal",
    "globalSettingEnabled": "Y"
  }
}

回應失敗JSON範例：

參數錯誤

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

欄位說明

參數名	類型	說明
code	int	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data		回傳的結果資訊
pageSkin		頻道的皮膚風格，如：blue green等
scene		頻道的直播場景，如：ppt（三分屏） alone等
mobileWatchLayout		頻道的行動端觀看佈局，normal 普通直播 portrait豎屏直播
watchLayout		頻道的pc端佈局， normal 普通直播 portrait 豎屏直播 ppt三分屏場景下文件為主 video三分屏場景下影片為主
watchTemplateType		頻道的觀看頁模板類型，如：old舊版 new新版等
globalSettingEnabled		是否應用全域設定，Y是，N不是

Java請求範例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/theme/get";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", 100001);
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }