保利威文档中心

幫助中心

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:關閉

回傳物件描述

修改預設模板禮物打賞設定回傳實體

联系客服,在线咨询