保利威文档中心

帮助中心

直播JAVA SDK

webInfo

更新时间：2025-10-29 14:26:06

1、设置频道名称

描述

设置频道名称
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channels/%s/update

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testUpdateChannelName() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelNameRequest liveUpdateChannelNameRequest = new LiveUpdateChannelNameRequest();
        Boolean liveUpdateChannelNameResponse;
        try {
            liveUpdateChannelNameRequest.setChannelId(createChannel())
                    .setName("Junit测试(勿删)");
            liveUpdateChannelNameResponse = new LiveWebInfoServiceImpl().updateChannelName(
                    liveUpdateChannelNameRequest);
            Assert.assertNotNull(liveUpdateChannelNameResponse);
            if (liveUpdateChannelNameResponse) {
                //to do something ......
                log.debug("测试设置频道名称成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回Boolean对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
name true String 修改后的频道名称
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

true为设置成功，false为设置失败



2、设置主持人姓名

描述

设置主持人姓名
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setPublisher

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testUpdateChannelPublisher() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelPublisherRequest liveUpdateChannelPublisherRequest = new LiveUpdateChannelPublisherRequest();
        Boolean liveUpdateChannelPublisherResponse;
        try {
            liveUpdateChannelPublisherRequest.setChannelId(createChannel())
                    .setPublisher("主讲老师");
            liveUpdateChannelPublisherResponse = new LiveWebInfoServiceImpl().updateChannelPublisher(
                    liveUpdateChannelPublisherRequest);
            Assert.assertNotNull(liveUpdateChannelPublisherResponse);
            if (liveUpdateChannelPublisherResponse) {
                //to do something ......
                log.debug("测试设置主持人姓名成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回Boolean对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
publisher true String 主持人姓名，不超过20个字符
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

true为设置成功，false为设置失败



3、查询直播引导图开关状态及URL

描述

查询直播引导图开关状态及URL
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/getSplash

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testGetChannelSplash() throws Exception, NoSuchAlgorithmException {
        LiveChannelSplashRequest liveChannelSplashRequest = new LiveChannelSplashRequest();
        LiveChannelSplashResponse liveChannelSplashResponse;
        try {
            liveChannelSplashRequest.setChannelId(createChannel());
            liveChannelSplashResponse = new LiveWebInfoServiceImpl().getChannelSplash(liveChannelSplashRequest);
            Assert.assertNotNull(liveChannelSplashResponse);
            if (liveChannelSplashResponse != null) {
                //to do something ......
                log.debug("测试查询直播引导图开关状态及URL成功,{}", JSON.toJSONString(liveChannelSplashResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回LiveChannelSplashResponse对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
splashImg String 引导图片url
splashEnabled String 引导功能开关,Y/N





4、设置频道图标

描述

设置频道图标
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setCoverImg

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testUpdateChannelLogo() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelLogoRequest liveUpdateChannelLogoRequest = new LiveUpdateChannelLogoRequest();
        String liveUpdateChannelLogoResponse;
        try {
            String path = getClass().getResource("/img/elephant.png").getPath();
            liveUpdateChannelLogoRequest.setChannelId(createChannel())
                    .setImgfile(new File(path));
            liveUpdateChannelLogoResponse = new LiveWebInfoServiceImpl().updateChannelLogo(
                    liveUpdateChannelLogoRequest);
            Assert.assertNotNull(liveUpdateChannelLogoResponse);
            if (liveUpdateChannelLogoResponse != null) {
                //to do something ......
                log.debug("测试设置频道图标成功,{}", liveUpdateChannelLogoResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回String对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
imgfile true File 图片为大小为2MB的JPG、JPEG、PNG图片
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

成功返回图标地址，如://livestatic.videocc.net/uploaded/images/2017/03/******.jpg



5、设置引导开关以及引导图片

描述

设置引导开关以及引导图片
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setSplash

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testUpdateChannelSplash() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelSplashRequest liveUpdateChannelSplashRequest = new LiveUpdateChannelSplashRequest();
        String liveUpdateChannelSplashResponse;
        try {
            String path = getClass().getResource("/img/elephant.png").getPath();
            liveUpdateChannelSplashRequest.setChannelId(createChannel())
//                    .setImgfile(new File(path))
                    .setSplashEnabled("Y");
            liveUpdateChannelSplashResponse = new LiveWebInfoServiceImpl().updateChannelSplash(
                    liveUpdateChannelSplashRequest);
            Assert.assertNotNull(liveUpdateChannelSplashResponse);
            if (liveUpdateChannelSplashResponse != null) {
                log.debug("设置引导开关以及引导图片成功,{}", liveUpdateChannelSplashResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回String对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
splashEnabled true String 设置开启或关闭引导页Y或N
imgfile false File 支持jpg、jpeg、png三种格式，大小不能超过4Mb
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

设置引导页未上传图片，成功返回success； 设置引导页同时上传图片;成功返回地址，如：//xxx.videocc.net/uploaded/images/2017/03/******.jpg



6、查询频道点赞数和观众热度值

描述

查询频道点赞数和观众热度值
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channels/live-likes

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testGetChannelLikes() throws Exception, NoSuchAlgorithmException {
        LiveChannelLikesRequest liveChannelLikesRequest = new LiveChannelLikesRequest();
        LiveChannelLikesResponse liveChannelLikesResponse;
        try {
            liveChannelLikesRequest.setChannelIds("1965681");
            liveChannelLikesResponse = new LiveWebInfoServiceImpl().getChannelLikes(liveChannelLikesRequest);
            Assert.assertNotNull(liveChannelLikesResponse);
            if (liveChannelLikesResponse != null) {
                //to do something ......
                log.debug("测试查询频道点赞数和观众热度值成功,{}", JSON.toJSONString(liveChannelLikesResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回LiveChannelLikesResponse对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelIds true String 用逗号隔开的频道号，如：10000,100001最多20个
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
channelLikes Array 频道点赞数和观众热度值【详见ChannelLikes参数描述】
ChannelLikes参数描述
参数名 类型 说明
channelId String 频道号
likes Integer 频道点赞数
viewers Integer 频道观看热度





7、设置频道直播倒计时信息

描述

设置频道直播倒计时信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/set-countdown

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testUpdateChannelCountDown() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelCountDownRequest liveUpdateChannelCountDownRequest = new LiveUpdateChannelCountDownRequest();
        Boolean liveUpdateChannelCountDownResponse;
        try {
            liveUpdateChannelCountDownRequest.setChannelId(createChannel())
                    .setBookingEnabled("Y")
                    .setStartTime(getDate(2020, 11, 11, 11, 11, 11));
            liveUpdateChannelCountDownResponse = new LiveWebInfoServiceImpl().updateChannelCountDown(
                    liveUpdateChannelCountDownRequest);
            Assert.assertTrue(liveUpdateChannelCountDownResponse);
            if (liveUpdateChannelCountDownResponse) {
                //to do something ......
                log.debug("测试设置频道直播倒计时信息成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回Boolean对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
bookingEnabled false String 预约观看开关Y或N
startTime false Date 直播开始时间，如果不传该值，表示不显示直播时间和倒计时（yyyy-MM-dd HH:mm:ss）
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

true为设置成功，false为设置失败



8、查询频道直播倒计时信息

描述

查询频道直播倒计时信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/get-countdown

调用约束

1、接口调用有频率限制，详细请查看，调用常见异常，详细请查看

单元测试

    @Test
    public void testGetChannelCountDown() throws Exception, NoSuchAlgorithmException {
        LiveChannelCountDownRequest liveChannelCountDownRequest = new LiveChannelCountDownRequest();
        LiveChannelCountDownResponse liveChannelCountDownResponse;
        try {
            liveChannelCountDownRequest.setChannelId(createChannel());
            liveChannelCountDownResponse = new LiveWebInfoServiceImpl().getChannelCountDown(
                    liveChannelCountDownRequest);
            Assert.assertNotNull(liveChannelCountDownResponse);
            if (liveChannelCountDownResponse != null) {
                //to do something ......
                log.debug("测试查询频道直播倒计时信息成功,{}", JSON.toJSONString(liveChannelCountDownResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确，返回LiveChannelCountDownResponse对象，B端依据此对象处理业务逻辑；

2、请求参数校验不合格，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败，失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常，抛出PloyvSdkException，错误信息见PloyvSdkException.getMessage()，如 [ 保利威请求返回数据错误，请求流水号：66e7ad29fd04425a84c2b2b562d2025b，错误原因： invalid signature. ]

请求入参描述

参数名 必选 类型 说明
channelId true String 频道号
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
bookingEnabled String 预约观看开关Y或N
startTime Date 直播开始时间,为空则没有直播开始时间

联系客服，在线咨询