修改频道图标

接口描述

1、设置频道图标
2、接口URL中的{channelId}为频道号
3、建议直接上传分辨率为128X128的图片
4、(timestamp, appId)参与sign签名,并和sign一起通过post表单传递,文件通过二进制流提交到服务器端。
5、接口支持https协议

接口URL

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

请求方式

POST

接口约束

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

2、上传的图片为不大于2MB的本地图片(格式只能为JPG、JPEG、PNG)。

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

imgfile

true

File

图片为大小为2MB的JPG、JPEG、PNG图片

示例

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

表单参数:

appId=frlr1zazn3&sign=ADF695A18E021A16E0738D0D4CB13C7B&timestamp=1621840589933

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

请求成功时,返回值是上传成功后的图片地址,请求失败时,返回值是空

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 testUpdateChannelLogo() 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/setCoverImg","1965681");
    String path = getClass().getResource("/file/").getPath() + "dog.jpeg";
    File file = new File(path);

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

}

响应示例

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

成功示例

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

异常示例

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

Last updated