查询频道页面装修

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	响应结果，由业务决定，成功返回true，失败返回false
data	Object	成功响应时返回频道详细信息【详见data字段说明】
error	Object	状态码非200时的错误信息【详见Error字段说明】
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
skin	String	皮肤，black：时尚黑，red：喜庆红，blue：科技蓝，white：经典白，green：薄荷绿，golden：富贵金
aloneWatchLayout	String	普通直播观看页布局配置(普通:normal,竖屏:portrait)
chat	Object	装修里聊天对象【详见TemplateDecorateChatBO字段说明】
desc	Object	装修中文直播介绍页对象【详见TemplateDecorateDescBO字段说明】
menus	Array	中文菜单列表对象【详见TemplateDecorateMenuBO字段说明】
player	Object	装修播放器对象【详见TemplateDecoratePlayerBO字段说明】
pptMobileWatchLayout	String	三分屏移动端观看布局,normal:常规直播,portrait:直播带货
splash	Object	装修引导页对象【详见TemplateDecorateSplashBO字段说明】
splashEnabled	String	引导页开关，Y：开启，N：关闭
englishSettingEnabled	String	双语直播间开关，Y：开启，N：关闭
enMenus	Array	英文菜单列表对象【详见TemplateDecorateMenuBO字段说明】
descEn	Object	模板-装修英文直播介绍页对象【详见TemplateDecorateDescEnBO字段说明】

TemplateDecorateChatBO参数描述

参数名	类型	说明
baseLikes	Integer	累计点赞人数 (点赞基数)
chatOnlineNumberEnable	String	在线人数开关，Y：开启，N：关闭
emotionEnabled	String	情绪直播间开关，情绪开关和点赞开关同时只能开启一个，Y：开启，N：关闭
redPackEnabled	String	红包开关，Y：开启，N：关闭
sendFlowersEnabled	String	点赞开关，Y：开启，N：关闭
viewerSendImgEnabled	String	发送图片开关，Y：开启，N：关闭
welcomeEnabled	String	欢迎语开关，Y：开启，N：关闭
withdrawEnabled	String	提现开关，Y：开启，N：关闭
portraitChatBgImg	String	竖屏聊天室背景图
portraitChatBgImgOpacity	String	竖屏聊天室背景图模糊度，0~50，值越大越模糊

TemplateDecorateDescBO参数描述

参数名	类型	说明
coverImageUrl	String	暖场图片 -> 封面图片
iconUrl	String	图标URL
publisher	String	主持人名称，最大长度50
title	String	标题 -> 直播名称，最大长度100

TemplateDecorateDescEnBO参数描述

参数名	类型	说明
publisher	String	主持人英文名称，最大长度50
title	String	直播英文名称，最大长度100

TemplateDecorateMenuBO参数描述

参数名	类型	说明
content	String	菜单内容
menuId	String	菜单ID
name	String	菜单名称
type	String	菜单类型 desc：直播介绍 chat：互动聊天 quiz：提问 qa：问答 invite：邀请海报 text：图文菜单 iframe：推广外链 tuwen：图文直播 previous：往期 buy：边看边买 members：成员列表 seat：坐席 multiMeeting：多会场

TemplateDecoratePlayerBO参数描述

参数名	类型	说明
actualPV	Integer	实际累计观看次数 (真实次数)
backgroundUrl	String	PC背景图片
basePV	Integer	基础观看次数
coverJumpUrl	String	封面(暖场)跳转链接
iconLink	String	水印链接
iconPosition	String	图标位置 (水印位置)
iconUrl	String	水印图片URL
logoOpacity	Float	水印不透明度，0：完全透明，1：完全不透明
warmUpEnabled	String	暖场开关，Y：开启，N：关闭
warmUpImageUrl	String	暖场图片地址 (直播封面图)
watermarkEnabled	String	水印开关,Y：开启，N：关闭

TemplateDecorateSplashBO参数描述

参数名	类型	说明
splashImageUrl	String	引导页图片

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
}