保利威文档中心

帮助中心

channelTemplate

更新时间:2025-09-11 15:18:09

1、查询直播模板打赏设置

描述

查询直播模板打赏设置,包括现金打赏、礼物打赏,礼物打赏又分为现金支付和积分支付
接口地址(仅做说明使用):https://api.polyv.net/live/v4/user/donate/get

调用约束

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

单元测试

    @Test
    public void testGetUserDonate() throws IOException, NoSuchAlgorithmException {
        LiveGetUserDonateRequest liveGetUserDonateRequest = new LiveGetUserDonateRequest();
        LiveGetUserDonateResponse liveGetUserDonateResponse;
        try {
            liveGetUserDonateResponse = new LiveChannelTemplateServiceImpl().getUserDonate(liveGetUserDonateRequest);
            Assert.assertNotNull(liveGetUserDonateResponse);
            if (liveGetUserDonateResponse != null) {
                //to do something ......
                log.debug("测试查询直播模板打赏设成功{}", JSON.toJSONString(liveGetUserDonateResponse));
            }
        } 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、请求正确,返回LiveGetUserDonateResponse对象,B端依据此对象处理业务逻辑;

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

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

请求入参描述

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

返回对象描述

参数名 类型 说明
donateCashEnabled String 现金红包打赏开关,Y:开启,N:关闭
cashDonate UserCashDonate 现金红包【详见UserCashDonate参数描述
donateGiftEnabled String 礼物打赏开关,Y:开启,N:关闭
giftDonate Array 礼物打赏(现金支付或积分支付)【详见UserGiftDonate参数描述
UserCashDonate参数描述
参数名 类型 说明
cashes Array 固定打赏金额,数组长度在1-6,最小值0.01,最大值9999.99【对应api文档的cashs字段】
cashMin Float 自定义打赏金额-最低金额,最小值0.01,最大值9999.99
UserGiftDonate参数描述
参数名 类型 说明
payWay String 支付方式,CASH:现金支付,POINT:积分支付
cashUnit String 现金单位
pointUnit String 积分单位
cashPays Array 现金支付列表【详见ChannelGift参数描述
pointPays Array 积分支付列表【详见ChannelGift参数描述
ChannelGift参数描述
参数名 类型 说明
name String 礼物名称
img String 礼物图片地址
price Float 礼物价格
enabled String 开关,Y:开启,N:关闭
ChannelGift参数描述
参数名 类型 说明
name String 礼物名称
img String 礼物图片地址
price Float 礼物价格
enabled String 开关,Y:开启,N:关闭






2、修改默认模板礼物打赏设置

描述

修改直播模板礼物打赏设置,礼物打赏又分为现金支付和积分支付
接口地址(仅做说明使用):https://api.polyv.net/live/v4/user/donate/gift/update

调用约束

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

单元测试

    @Test
    public void testUpdateUserDonate() throws IOException, NoSuchAlgorithmException {
        LiveUpdateUserDonateRequest liveUpdateUserDonateRequest = new LiveUpdateUserDonateRequest();
        Boolean liveUpdateUserDonateResponse;
        try {
            LiveUpdateUserDonateRequest.UserGiftDonate giftDonate = new LiveUpdateUserDonateRequest.UserGiftDonate();
            List<LiveUpdateUserDonateRequest.UserGift> giftList = new ArrayList<>();
            LiveUpdateUserDonateRequest.UserGift gift1 = new LiveUpdateUserDonateRequest.UserGift();
            gift1.setImg("//liveimages.videocc.net/uploaded/images/2021/11/g41in083xo.png")
                    .setName("现金礼物")
                    .setPrice(Float.valueOf("1.66"))
                    .setEnabled(LiveConstant.Flag.YES.getFlag());
            giftList.add(gift1);
            List<LiveUpdateUserDonateRequest.UserGift> pointList = new ArrayList<>();
            LiveUpdateUserDonateRequest.UserGift pointGift1 = new LiveUpdateUserDonateRequest.UserGift();
            pointGift1.setImg("//s1.videocc.net/default-img/donate/666.png")
                    .setName("积分礼物")
                    .setPrice(Float.valueOf("12.88"))
                    .setEnabled(LiveConstant.Flag.YES.getFlag());
            LiveUpdateUserDonateRequest.UserGift pointGift2 = new LiveUpdateUserDonateRequest.UserGift();
            pointGift2.setImg("https://liveimages.videocc.net/uploaded/images/2021/11/g4b3010gmm.gif")
                    .setName("积分礼物2")
                    .setPrice(Float.valueOf("66.88"))
                    .setEnabled(LiveConstant.Flag.YES.getFlag());
            pointList.add(pointGift1);
            pointList.add(pointGift2);
            giftDonate.setPayWay(LiveConstant.PayWay.POINT.getValue())
                    .setCashPays(giftList)
                    .setPointPays(pointList)
                    .setPointUnit("polyv积分");
            liveUpdateUserDonateRequest.setGiftDonate(giftDonate);
            liveUpdateUserDonateRequest.setDonateGiftEnabled(LiveConstant.Flag.YES.getFlag());
            liveUpdateUserDonateResponse = new LiveChannelTemplateServiceImpl().updateUserDonate(
                    liveUpdateUserDonateRequest);
            Assert.assertTrue(liveUpdateUserDonateResponse);
            if (liveUpdateUserDonateResponse) {
                //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. ]

请求入参描述

参数名 必选 类型 说明
donateGiftEnabled false String 礼物打赏开关,Y:开启,N:关闭
giftDonate false UserGiftDonate 礼物打赏(现金支付或积分支付)【详见UserGiftDonate参数描述
appId false String POLYV用户APP_ID,多账号调用时该参数必填(即调用了initMultiAccount()设置多账号调用),通过注册保利威官网获取,路径:官网->登录->直播(开发设置)
appSecret false String POLYV用户APP_SECRET,多账号调用时该参数必填(即调用了initMultiAccount()设置多账号调用),通过注册保利威官网获取,路径:官网->登录->直播(开发设置)
UserGiftDonate参数描述
参数名 必选 类型 说明
payWay false String 支付方式,CASH:现金支付,POINT:积分支付
cashUnit false String 现金单位
pointUnit false String 积分单位
cashPays false Array 现金支付列表【详见UserGift参数描述
pointPays false Array 积分支付列表【详见UserGift参数描述
UserGift参数描述
参数名 必选 类型 说明
name false String 礼物名称
img false String 礼物图片地址
price false Float 礼物价格
enabled false String 开关,Y:开启,N:关闭
UserGift参数描述
参数名 必选 类型 说明
name false String 礼物名称
img false String 礼物图片地址
price false Float 礼物价格
enabled false String 开关,Y:开启,N:关闭

返回对象描述

修改默认模板礼物打赏设置返回实体

联系客服,在线咨询