Query Channel Page Decoration

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameter Description

Example

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

Response Parameter Description

Error Parameter Description

Data Parameter Description

TemplateDecorateChatBO Parameter Description

TemplateDecorateDescBO Parameter Description

TemplateDecorateDescEnBO Parameter Description

TemplateDecorateMenuBO Parameter Description

TemplateDecoratePlayerBO Parameter Description

TemplateDecorateSplashBO Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java, both 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.

    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);
    }

Response Example

Success Example

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

Error Example

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