修改暖场图片

接口描述

1、通过频道号,修改播放器的暖场图片
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"
4、暖场视频和暖场图片是处于非直播状态时,播放器显示的画面,两者在同一时间只能显示一种,以最晚设置者为准
5、若想删除暖场画面,则将coverImage或warmUpFlv的值设为"http://"

接口URL

http://api.polyv.net/live/v2/channels/{channelId}/update

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

coverImage

true

String

暖场图片地址,图片大小建议:800x450,支持PNG、JPEG、GIF格式

coverHref

false

String

暖场图片跳转地址

示例

http://api.polyv.net/live/v2/channels/2191569/update

表单参数:

appId=frlr1zazn3&coverImage=http%3A%2F%2F&sign=202FBC44F55FA11EF1C7087C43B9A0F0&coverHref=&timestamp=1621842475525

响应参数描述

参数名类型说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

String

请求失败时为空,请求成功时为true

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelWarmUpTest.class);

/**
 * 修改暖场图片
 * @throws IOException
 */
@Test
public void testUpdateWarmUpImage() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v2/channels/"+channelId+"/update";
        String coverImage = "http://static.live.polyv.net/uploaded/images/2016/07/egqo3soa33.jpg";
        String coverHref = "";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("coverImage",coverImage);
        requestMap.put("coverHref",coverHref);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试修改暖场图片接口返回值:{}",response);

}

注意:设置暖场图片地址的域名下必需增加crossdomain.xml文件

<cross-domain-policy>
<allow-access-from domain="*"/>
</cross-domain-policy>

响应示例

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

成功示例

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

异常示例

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

Last updated