Modify Channel Decoration Settings

API Description

1、修改频道的页面装修设置，建议将 查询频道的页面装修设置 接口的返回值进行修改作为入参调用该接口
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

1. This API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

2. Image resource domains for this API currently only support Polyv image domains. Images must be converted via the Upload All Channel Decoration Image Materials API.

Request Parameter Description

Request Body Parameter Description

TemplateDecorateChat Parameter Description

TemplateDecorateDesc Parameter Description

TemplateDecorateDescEn Parameter Description

TemplateDecorateMenu Parameter Description

TemplateDecoratePlayer Parameter Description

TemplateDecorateSplash Parameter Description

Example

http://api.polyv.net/live/v4/channel/decorate/update?appId=frlr1zazn3&sign=45DD8012F5392F24018CAAD344DAF090&channelId=2523307&timestamp=1630984838533

Request body JSON parameters:

{
    "player": {
        "backgroundUrl": "http://liveimages.videocc.net/uploadimage/20210312/chat_img_1b448be323_16155164629438.jpeg?x-oss-process=image/resize,mfit,w_1280,h_720,limit_1",
        "basePV": 2000,
        "iconLink": "http://www.polyv.net",
        "iconPosition": "br",
        "warmUpEnabled": "N",
        "iconUrl": "http://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "watermarkEnabled": "Y",
        "coverJumpUrl": "",
        "warmUpImageUrl": "",
        "actualPV": 200,
        "logoOpacity": "0.7"
    },
    "englishSettingEnabled": "Y",
    "descEn": {
        "publisher": "Polyv special host",
        "title": "Polyv talk"
    },
    "chat": {
        "emotionEnabled": "N",
        "baseLikes": 800,
        "viewerSendImgEnabled": "N",
        "redPackEnabled": "N",
        "sendFlowersEnabled": "N",
        "welcomeEnabled": "N",
        "chatOnlineNumberEnable": "N",
        "withdrawEnabled": "N"
    },
    "skin": "red",
    "splashEnabled": "Y",
    "menus": [
        {
            "type": "desc"
        },
        {
            "type": "chat"
        }
    ],
    "enMenus": [
        {
            "name": "desc",
            "type": "desc"
        },
        {
            "name": "talk",
            "type": "chat"
        }
    ],
    "lang": "zh_CN",
    "splash": {
        "splashImageUrl": ""
    },
    "desc": {
        "publisher": "polyv专用主持人",
        "iconUrl": "http://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "title": "polyv宣讲会"
    }
}

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. Add it to your own project after downloading. HttpUtil.java and LiveSignUtil.java from the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

    @Test
    public void updateChannelDecorate() 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/update";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", "2523307");
        
        Map<String, Object> chatMap = new HashMap<>();
        chatMap.put("baseLikes",800);
        chatMap.put("chatOnlineNumberEnable","N");
        chatMap.put("emotionEnabled","N");
        chatMap.put("redPackEnabled","N");
        chatMap.put("sendFlowersEnabled","N");
        chatMap.put("viewerSendImgEnabled","N");
        chatMap.put("welcomeEnabled","N");
        chatMap.put("withdrawEnabled","N");
        
        Map<String, Object> descMap = new HashMap<>();
        //图标URL
        descMap.put("iconUrl","http://liveimages.videocc.net/assets/wimages/pc_images/logo.png");
        descMap.put("publisher","polyv专用主持人");
        descMap.put("title","polyv宣讲会");
        
        Map<String, Object> descEnMap = new HashMap<>();
        descEnMap.put("publisher","Polyv special host");
        descEnMap.put("title","Polyv talk");
        
        Map<String, Object> enMenusMap1 = new HashMap<>();
        enMenusMap1.put("name","desc");
        enMenusMap1.put("type","desc");
        Map<String, Object> enMenusMap2 = new HashMap<>();
        enMenusMap2.put("name","talk");
        enMenusMap2.put("type","chat");
        List<Map<String,Object>> enMenusList = new ArrayList<>();
        enMenusList.add(enMenusMap1);enMenusList.add(enMenusMap2);
        
        Map<String, Object> chMenusMap1 = new HashMap<>();
        chMenusMap1.put("name","直播间描述");
        chMenusMap1.put("type","desc");
        Map<String, Object> chMenusMap2 = new HashMap<>();
        chMenusMap2.put("name","聊天");
        chMenusMap2.put("type","chat");
        List<Map<String,Object>> chMenusList = new ArrayList<>();
        chMenusList.add(chMenusMap1);chMenusList.add(chMenusMap2);
        
        Map<String, Object> playMap = new HashMap<>();
        playMap.put("actualPV",200);
        playMap.put("backgroundUrl","http://liveimages.videocc.net/uploadimage/20210312/chat_img_1b448be323_16155164629438.jpeg?x-oss-process=image/resize,mfit,w_1280,h_720,limit_1");
        playMap.put("basePV",2000);
        playMap.put("coverJumpUrl","");
        playMap.put("watermarkEnabled","Y");
        playMap.put("iconLink","http://www.polyv.net");
        playMap.put("iconPosition","br");
        playMap.put("iconUrl","http://liveimages.videocc.net/assets/wimages/pc_images/logo.png");
        playMap.put("logoOpacity","0.7");//水印不透明度
        playMap.put("warmUpEnabled","N");
        playMap.put("warmUpImageUrl","");
        
        Map<String, Object> splashMap = new HashMap<>();
        splashMap.put("splashImageUrl","");
        
        Map<String, Object> bodyMap = new HashMap<>();
        bodyMap.put("chat", chatMap);
        bodyMap.put("desc", descMap);
        bodyMap.put("descEn", descEnMap);
        bodyMap.put("enMenus", enMenusList);
        bodyMap.put("menus", chMenusList);
        bodyMap.put("englishSettingEnabled", "Y");//双语直播间开关
        bodyMap.put("lang", "zh_CN");
        bodyMap.put("player", playMap);
        bodyMap.put("skin", "red");
        bodyMap.put("splash", splashMap);
        bodyMap.put("splashEnabled", "Y");
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String body = JSON.toJSONString(bodyMap);
        url = HttpUtil.appendUrl(url, requestMap);
        String response = HttpUtil.postJsonBody(url,body,null);
        
        log.info("测试修改频道装修设置，返回值：{}", response);
    }

Response Example

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "dc7ae621ef8e4f4a8e4976833f1dbbd4.69.16309852981551185",
    "data": null,
    "success": true
}

Error Example

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