获取频道的皮肤设置信息接口
更新时间：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);
}
