批量修改频道皮肤
更新时间:2022-09-02 18:08:07
接口描述
1、批量修改频道装修皮肤
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/decorate/skin/update-batch
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、仅支持新版后台、旧版后台如果该频道号开启了通用设置,无法修改成功。
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelIds | true | String | 用英文逗号隔开的频道号,如:10000,100001 最多500个 |
| skin | true | String | 皮肤 black:时尚黑 red:喜庆红 blue:科技蓝 white:经典白 green:薄荷绿 golden:富贵金 |
示例
http://api.polyv.net/live/v4/channel/decorate/skin/update-batch?appId=frlr1zazn3&skin=green&sign=3BF08DAE570AAA601D2E12A3AA85E622&channelIds=2272655%2C1965681%2C2477096×tamp=1646289479777
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 成功响应时返回true,失败时返回false |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
/**
* 批量修改频道皮肤
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateSkin() 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/skin/update-batch";
String channelIds = "2272655,1965681,2477096";
String skin = "green";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelIds", channelIds);
requestMap.put("skin", skin);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postFormBody(url, null);
log.info("测试批量修改频道皮肤,返回值:{}", response);
}
响应示例
成功示例
{
"code": 200,
"status": "success",
"requestId": "9975d9a5cfb04944a89c7c7e14868ac2.70.16462894821814759",
"data": true,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360828899123425",
"error": {
"code": 30004,
"desc": "找不到频道"
},
"success": false
}
