webInteract

1. Setting Up Prop Rewards

Description

设置道具打赏
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/donate/update-good

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testUpdateChannelGood() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelGoodRequest liveUpdateChannelGoodRequest = new LiveUpdateChannelGoodRequest();
        Boolean liveUpdateChannelGoodResponse;
        try {
            List<LiveUpdateChannelGoodRequest.ChannelGood> channelGoods =
                    new ArrayList<LiveUpdateChannelGoodRequest.ChannelGood>();
            LiveUpdateChannelGoodRequest.ChannelGood channelGood = new LiveUpdateChannelGoodRequest.ChannelGood();
            channelGood.setGoodName("佛跳墙")
                    .setGoodImg("//livestatic.videocc.net/uploaded/images/webapp/channel/donate/07-diamond.png")
                    .setGoodPrice(9999.99)
                    .setGoodEnabled("Y");
            channelGoods.add(channelGood);
            liveUpdateChannelGoodRequest.setChannelId(createChannel()).setEnabled("Y").setGoods(channelGoods);
            liveUpdateChannelGoodResponse = new LiveWebInteractServiceImpl().updateChannelGood(
                    liveUpdateChannelGoodRequest);
            Assert.assertNotNull(liveUpdateChannelGoodResponse);
            if (liveUpdateChannelGoodResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

ChannelGood Parameter Description

Return Object Description

true indicates success, false indicates failure

2. Setting Cash Tips

Description

用于设置频道或者全局现金打赏
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/donate/update-cash

Call Constraints

1. The API call is subject to rate limits. For details, see here. For common call exceptions, see here.

2. Include the channel number to set cash tips for a specific channel; omit the channel number to default to global cash tip settings.

Unit Test

    @Test
    public void testUpdateChannelCash() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelCashRequest liveUpdateChannelCashRequest = new LiveUpdateChannelCashRequest();
        Boolean liveUpdateChannelCashResponse;
        try {
            Double[] floats = {0.88d, 6.66d, 8.88d, 18.11d, 66.60d, 88.89d};
            List<Double> cashes = Arrays.asList(floats);
            liveUpdateChannelCashRequest.setChannelId(createChannel())
                    .setCashes(cashes)
                    .setCashMin(0.02d)
                    .setEnabled("Y");
            liveUpdateChannelCashResponse = new LiveWebInteractServiceImpl().updateChannelCash(
                    liveUpdateChannelCashRequest);
            Assert.assertNotNull(liveUpdateChannelCashResponse);
            if (liveUpdateChannelCashResponse) {
                //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;
        }
    }

Unit Test Description

1. If the request is correct, a Boolean object is returned, and the B-side processes the business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed fields [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

true indicates success, false indicates failure.

3. Query Tip Settings

Description

查询打赏设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/donate/get

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testGetChannelDonate() throws Exception, NoSuchAlgorithmException {
        LiveChannelDonateRequest liveChannelDonateRequest = new LiveChannelDonateRequest();
        LiveChannelDonateResponse liveChannelDonateResponse;
        try {
            liveChannelDonateRequest.setChannelId(createChannel());
            liveChannelDonateResponse = new LiveWebInteractServiceImpl().getChannelDonate(liveChannelDonateRequest);
            Assert.assertNotNull(liveChannelDonateResponse);
            if (liveChannelDonateResponse != null) {
                //to do something ......
                log.debug("测试查询打赏设置成功,{}", JSON.toJSONString(liveChannelDonateResponse));
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a LiveChannelDonateResponse object, based on which the B-side processes the business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

ChannelGood Parameter Description

4. Set Channel WeChat Sharing Information

Description

用于修改频道的微信分享相关设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/weixin-share/update

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testUpdateChannelWxShare() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelWxShareRequest liveUpdateChannelWxShareRequest = new LiveUpdateChannelWxShareRequest();
        Boolean liveUpdateChannelWxShareResponse;
        try {
            liveUpdateChannelWxShareRequest.setChannelId(createChannel())
                    .setWxShareTitle("Mysql 知识精讲")
                    .setWxShareDesc("带你走进Mysql的奇妙世界");
            liveUpdateChannelWxShareResponse = new LiveWebInteractServiceImpl().updateChannelWxShare(
                    liveUpdateChannelWxShareRequest);
            Assert.assertTrue(liveUpdateChannelWxShareResponse);
            if (liveUpdateChannelWxShareResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

true indicates success, false indicates failure

5. Query Channel WeChat Sharing Information

Description

获取频道的微信分享设置信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/weixin-share/get

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testGetChannelWxShare() throws Exception, NoSuchAlgorithmException {
        LiveGetChannelWxShareRequest liveGetChannelWxShareRequest = new LiveGetChannelWxShareRequest();
        LiveGetChannelWxShareResponse liveGetChannelWxShareResponse;
        try {
            liveGetChannelWxShareRequest.setChannelId(createChannel());
            liveGetChannelWxShareResponse = new LiveWebInteractServiceImpl().getChannelWxShare(
                    liveGetChannelWxShareRequest);
            Assert.assertNotNull(liveGetChannelWxShareResponse);
            if (liveGetChannelWxShareResponse != null) {
                //to do something ......
                log.debug("测试查询频道微信分享信息成功，{}", JSON.toJSONString(liveGetChannelWxShareResponse));
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a LiveGetChannelWxShareResponse object, and the B-side processes the business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

6. Query Channel Tip Settings

Description

查询频道打赏设置，包括现金打赏、礼物打赏，礼物打赏又分为现金支付和积分支付
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/donate/get

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testGetChannelDonateV2() throws IOException, NoSuchAlgorithmException {
        LiveGetChannelDonateRequest liveGetChannelDonateRequest = new LiveGetChannelDonateRequest();
        LiveGetChannelDonateResponse liveGetChannelDonateResponse;
        try {
            String channelId = super.createChannel();
            liveGetChannelDonateRequest.setChannelId(channelId);
            liveGetChannelDonateResponse = new LiveWebInteractServiceImpl().getChannelDonateV2(
                    liveGetChannelDonateRequest);
            Assert.assertNotNull(liveGetChannelDonateResponse);
            if (liveGetChannelDonateResponse != null) {
                //to do something ......
                log.debug("测试查询频道打赏设置成功{}", JSON.toJSONString(liveGetChannelDonateResponse));
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a LiveGetChannelDonateResponse object, based on which the B-side processes business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

ChannelCashDonate Parameter Description

ChannelGiftDonate Parameter Description

ChannelGift Parameter Description

ChannelGift Parameter Description

7. Modify Channel Gift Reward Settings

Description

修改频道礼物打赏设置，礼物打赏又分为现金支付和积分支付
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/donate/gift/update

Call Constraints

1. The API call has a frequency limit. Click here for details. For common call exceptions, click here for details.

Unit Testing

    @Test
    public void testUpdateChannelDonateV2() throws IOException, NoSuchAlgorithmException {
        LiveUpdateChannelDonateRequest liveUpdateChannelDonateRequest = new LiveUpdateChannelDonateRequest();
        Boolean liveUpdateChannelDonateResponse;
        try {
            LiveUpdateChannelDonateRequest.ChannelGiftDonate giftDonate =
                    new LiveUpdateChannelDonateRequest.ChannelGiftDonate();
            List<LiveUpdateChannelDonateRequest.ChannelGift> giftList = new ArrayList<>();
            LiveUpdateChannelDonateRequest.ChannelGift gift1 = new LiveUpdateChannelDonateRequest.ChannelGift();
            gift1.setImg("//liveimages.videocc.net/uploaded/images/2021/11/g41in083xo.png")
                    .setName("现金礼物1")
                    .setPrice(Float.valueOf("66.66"))
                    .setEnabled(LiveConstant.Flag.YES.getFlag());
            giftList.add(gift1);
            List<LiveUpdateChannelDonateRequest.ChannelGift> pointList = new ArrayList<>();
            LiveUpdateChannelDonateRequest.ChannelGift gift2 = new LiveUpdateChannelDonateRequest.ChannelGift();
            gift2.setImg("//s1.videocc.net/default-img/donate/666.png")
                    .setName("积分礼物1")
                    .setPrice(Float.valueOf("88.88"))
                    .setEnabled(LiveConstant.Flag.YES.getFlag());
            pointList.add(gift2);
            giftDonate.setPayWay(LiveConstant.PayWay.CASH.getValue())
                    .setCashPays(giftList)
                    .setPointPays(pointList)
                    .setPointUnit("polyv积分");
            liveUpdateChannelDonateRequest.setGiftDonate(giftDonate);
            liveUpdateChannelDonateRequest.setDonateGiftEnabled(LiveConstant.Flag.YES.getFlag());
            liveUpdateChannelDonateRequest.setChannelId(super.createChannel());
            liveUpdateChannelDonateResponse = new LiveWebInteractServiceImpl().updateChannelDonateV2(
                    liveUpdateChannelDonateRequest);
            Assert.assertTrue(liveUpdateChannelDonateResponse);
            if (liveUpdateChannelDonateResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned. The B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

ChannelGiftDonate Parameter Description

ChannelGift Parameter Description

ChannelGift Parameter Description

Return Object Description

Modify Channel Gift Reward Settings Return Entity

8. Query Channel Card Push

Description

查询频道卡片推送，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/list

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testGetChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LiveGetChannelCardPushRequest liveGetChannelCardPushRequest = new LiveGetChannelCardPushRequest();
        List<LiveGetChannelCardPushResponse> liveGetChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            liveGetChannelCardPushRequest.setChannelId(channelId);
            liveGetChannelCardPushResponse = new LiveWebInteractServiceImpl().getChannelCardPush(
                    liveGetChannelCardPushRequest);
            Assert.assertNotNull(liveGetChannelCardPushResponse);
            if (liveGetChannelCardPushResponse != null) {
                //to do something ......
                log.debug("测试查询频道卡片推送成功{}", JSON.toJSONString(liveGetChannelCardPushResponse));
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a LiveGetChannelCardPushResponse object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

The return object is List<LiveGetChannelCardPushResponse>. The specific elements of LiveGetChannelCardPushResponse are as follows:

9. Create Channel Card Push

Description

创建频道卡片推送，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/create

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testCreateChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LiveCreateChannelCardPushRequest liveCreateChannelCardPushRequest = new LiveCreateChannelCardPushRequest();
        LiveCreateChannelCardPushResponse liveCreateChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            liveCreateChannelCardPushRequest.setChannelId(channelId)
                    .setTitle("测试SDK卡片推送")
                    .setLink("http://polyv.net")
                    .setImageType(LiveConstant.ImageType.GIFT_BOX.getValue())
                    .setDuration(LiveConstant.CardPushDuration.DURATION_TEN.getValue())
                    .setShowCondition(LiveConstant.ShowCondition.WATCH.getValue())
                    .setConditionValue(10)
                    .setConditionUnit(LiveConstant.ConditionUnit.SECONDS.getValue())
                    .setCountdownMsg("倒计时")
                    .setEnterEnabled(LiveConstant.Flag.YES.getFlag());
            liveCreateChannelCardPushResponse = new LiveWebInteractServiceImpl().createChannelCardPush(
                    liveCreateChannelCardPushRequest);
            Assert.assertNotNull(liveCreateChannelCardPushResponse);
            if (liveCreateChannelCardPushResponse != null) {
                //to do something ......
                log.debug("测试创建频道卡片推送成功{}", JSON.toJSONString(liveCreateChannelCardPushResponse));
                //TODO 此处创建完成后删除了卡片推送，正式使用需删除该语句
                super.deleteChannelPushCard(channelId, liveCreateChannelCardPushResponse.getId());
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a LiveCreateChannelCardPushResponse object, based on which the B-side processes business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

10. Modify Channel Card Push

Description

修改频道卡片推送，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/update

Call Constraints

1. The API call is subject to rate limits. For details, see [/live/java/limit.md]. For common call exceptions, see [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testUpdateChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LiveUpdateChannelCardPushRequest liveUpdateChannelCardPushRequest = new LiveUpdateChannelCardPushRequest();
        Boolean liveUpdateChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            liveUpdateChannelCardPushRequest.setChannelId(channelId)
                    .setCardPushId(super.getChannelCardPushId(channelId))
                    .setTitle("测试SDK修改卡片推送")
                    .setLink("https://polyv.net");
            liveUpdateChannelCardPushResponse = new LiveWebInteractServiceImpl().updateChannelCardPush(
                    liveUpdateChannelCardPushRequest);
            Assert.assertTrue(liveUpdateChannelCardPushResponse);
            if (liveUpdateChannelCardPushResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Modify the channel card push return entity

11. Delete Card Push

Description

删除卡片推送，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/delete

Call Constraints

1. The API call has a frequency limit. Click here for details. For common call exceptions, click here for details.

Unit Testing

    @Test
    public void testDeleteChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LiveDeleteChannelCardPushRequest liveDeleteChannelCardPushRequest = new LiveDeleteChannelCardPushRequest();
        Boolean liveDeleteChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            liveDeleteChannelCardPushRequest.setChannelId(channelId)
                    .setCardPushId(super.getChannelCardPushId(channelId));
            liveDeleteChannelCardPushResponse = new LiveWebInteractServiceImpl().deleteChannelCardPush(
                    liveDeleteChannelCardPushRequest);
            Assert.assertTrue(liveDeleteChannelCardPushResponse);
            if (liveDeleteChannelCardPushResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Delete card push return entity

12. Push Channel Card

Description

推送频道卡片，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/push

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testPushChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LivePushChannelCardPushRequest livePushChannelCardPushRequest = new LivePushChannelCardPushRequest();
        Boolean livePushChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            Long cardPushId = super.getChannelCardPushId(channelId);
            livePushChannelCardPushRequest.setChannelId(channelId).setCardPushId(cardPushId);
            livePushChannelCardPushResponse = new LiveWebInteractServiceImpl().pushChannelCardPush(
                    livePushChannelCardPushRequest);
            Assert.assertTrue(livePushChannelCardPushResponse);
            if (livePushChannelCardPushResponse) {
                //to do something ......
                log.debug("测试推送频道卡片成功");
                //TODO 此处创建完成后删除了卡片推送，正式使用需删除该语句
                super.deleteChannelPushCard(channelId, cardPushId);
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Push channel card returns entity

13. Cancel Push Card

Description

取消推送卡片，对应新版后台的 营销-卡片
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/card-push/cancel-push

Call Constraints

1. The API call is subject to rate limits. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testCancelPushChannelCardPush() throws IOException, NoSuchAlgorithmException {
        LiveCancelPushChannelCardPushRequest liveCancelPushChannelCardPushRequest =
                new LiveCancelPushChannelCardPushRequest();
        Boolean liveCancelPushChannelCardPushResponse;
        try {
            String channelId = super.createChannel();
            liveCancelPushChannelCardPushRequest.setChannelId(channelId)
                    .setCardPushId(super.getChannelPushingCardId(channelId));
            liveCancelPushChannelCardPushResponse = new LiveWebInteractServiceImpl().cancelPushChannelCardPush(
                    liveCancelPushChannelCardPushRequest);
            Assert.assertTrue(liveCancelPushChannelCardPushResponse);
            if (liveCancelPushChannelCardPushResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Cancel push card to return entity

14. Query Channel WeChat Sharing Information

Description

查询频道微信分享信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/share/get

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testGetChannelShare() throws IOException, NoSuchAlgorithmException {
        LiveGetChannelShareRequest liveGetChannelShareRequest = new LiveGetChannelShareRequest();
        LiveGetChannelShareResponse liveGetChannelShareResponse;
        try {
            String channelId = super.createChannel();
            liveGetChannelShareRequest.setChannelId(channelId);
            liveGetChannelShareResponse = new LiveWebInteractServiceImpl().getChannelShare(liveGetChannelShareRequest);
            Assert.assertNotNull(liveGetChannelShareResponse);
            if (liveGetChannelShareResponse != null) {
                //to do something ......
                log.debug("测试查询频道微信分享信息成功{}", JSON.toJSONString(liveGetChannelShareResponse));
            }
        } 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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a LiveGetChannelShareResponse object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed fields [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

15. Modify Channel WeChat Sharing Information

Description

修改频道微信分享信息，对应新版后台的 营销-分享设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/share/update

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testUpdateChannelShare() throws IOException, NoSuchAlgorithmException {
        LiveUpdateChannelShareRequest liveUpdateChannelShareRequest = new LiveUpdateChannelShareRequest();
        Boolean liveUpdateChannelShareResponse;
        try {
            String channelId = super.createChannel();
            liveUpdateChannelShareRequest.setChannelId(channelId)
                    .setShareBtnEnable(LiveConstant.Flag.YES.getFlag())
                    .setTitleType(LiveConstant.TitleType.FOLLOW.getValue());
            liveUpdateChannelShareResponse = new LiveWebInteractServiceImpl().updateChannelShare(
                    liveUpdateChannelShareRequest);
            Assert.assertTrue(liveUpdateChannelShareResponse);
            if (liveUpdateChannelShareResponse) {
                //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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Modify the channel WeChat sharing information return entity