查詢頻道頁面裝潢

介面描述

1、查询频道的页面装修设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/decorate/get

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

範例

http://api.polyv.net/live/v4/channel/decorate/get?appId=frlr1zacn3&sign=0F412B15C2DC032517E1D29BD4452C43&channelId=2523307&timestamp=1630996829815

回應參數描述

Error參數描述

data參數描述

TemplateDecorateChatBO參數描述

TemplateDecorateDescBO參數描述

TemplateDecorateDescEnBO參數描述

TemplateDecorateMenuBO參數描述

TemplateDecoratePlayerBO參數描述

TemplateDecorateSplashBO參數描述

Java請求範例

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

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

    private static final Logger log = LoggerFactory.getLogger(ChannelDecorateTest.class);
    
    @Test
    public void getChannelDecorate() throws IOException, NoSuchAlgorithmException {
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/live/v4/channel/decorate/get";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", "2523307");
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String response = HttpUtil.get(url,requestMap);
        
        log.info("测试修改频道装修设置，返回值：{}", response);
    }

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "dc7ae621ef8e4f4a8e4976833f1dbbd4.66.16309975070362179",
    "data": {
        "skin": "red",
        "aloneWatchLayout": "normal",
        "pptMobileWatchLayout": "normal",
        "englishSettingEnabled": "Y",
        "player": {
            "watermarkEnabled": null,
            "iconUrl": "//liveimages.videocc.net/uploaded/images/2021/09/g24vjlhywx.png",
            "iconPosition": "br",
            "logoOpacity": 1,
            "iconLink": "",
            "basePV": 6,
            "actualPV": 21,
            "warmUpEnabled": "Y",
            "warmUpImageUrl": "http://liveimages.videocc.net/uploadimage/20210312/chat_img_1b448be323_16155164629438.jpeg",
            "coverJumpUrl": "",
            "backgroundUrl": ""
        },
        "desc": {
            "coverImageUrl": "http://liveimages.videocc.net/uploadimage/20210312/chat_img_1b448be323_16155164629438.jpeg",
            "iconUrl": "http://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
            "title": "polyv宣讲会",
            "publisher": "polyv专用主持人"
        },
        "descEn": null,
        "chat": {
            "sendFlowersEnabled": "N",
            "baseLikes": 800,
            "withdrawEnabled": "N",
            "redPackEnabled": "N",
            "chatOnlineNumberEnable": "N",
            "viewerSendImgEnabled": "N",
            "welcomeEnabled": "N",
            "emotionEnabled": "N"
        },
        "menus": [
            {
                "menuId": "1435122684833112066",
                "name": "直播间描述",
                "type": "desc",
                "content": null
            },
            {
                "menuId": "1435122684837306369",
                "name": "聊天",
                "type": "chat",
                "content": null
            }
        ],
        "enMenus": [
            {
                "menuId": "1435080554799091714",
                "name": "desc",
                "type": "desc",
                "content": null
            },
            {
                "menuId": "1435132950782222337",
                "name": "talk",
                "type": "chat",
                "content": null
            }
        ],
        "splash": {
            "splashImageUrl": ""
        },
        "splashEnabled": "Y"
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360828899123425",
    "error": {
        "code": 30004,
        "desc": "找不到频道"
    },
    "success": false
}