修改引导图

接口描述

1、接口用于设置引导页开关以及引导图
2、接口URL中的{channelId}为频道号
3、（splashEnabled, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
4、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/setSplash

请求方式

POST

接口约束

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

2、开启开关且之前未设置过引导图，则上传图片不能为空。

3、引导图要求：只能为jpg、jpeg、png三种格式，大小不能超过4Mb。

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
splashEnabled	true	String	设置开启或关闭引导页 Y：开启 N：关闭
imgfile	false	File	支持jpg、jpeg、png三种格式，大小不能超过4Mb

示例

http://api.polyv.net/live/v2/channelSetting/1965681/setSplash

表单参数：

appId=frlr1zazn3&sign=59FA01DD41788BA25D8FE31827C30BD2&splashEnabled=Y&timestamp=1621840626094

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时，如果上传图片则为图片url，无上传图片则为"success"，请求失败时返回空字符串

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(WebInfoTest.class);
/**
 * 修改引导图
 * @throws IOException
 */
@Test
public void testSetSplash() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/setSplash","1965681");
    String splashEnabled = "Y";
    String path = getClass().getResource("/file/").getPath() + "dog.jpeg";
    File imgfile = new File(path);

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("splashEnabled",splashEnabled);
    Map<String, File> fileMap = new HashMap<>();
    fileMap.put("imgfile",imgfile);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url,requestMap,fileMap,"utf-8");
    log.info("测试修改引导图：{}",response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

1、设置引导页，未上传图片

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

2、设置引导页，同时上传图片

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"//liveimages.videocc.net/uploaded/images/2021/03/fx0zmiovdd.jpeg"
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}