保利威文档中心

幫助中心

webInteract

更新時間:2025-09-11 15:18:09

1、設定道具打賞

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求參數說明

參數名 必填 類型 說明
channelId String 頻道號,不傳則為全域設定
enabled String 請求體參數,道具打賞開關,不傳預設開啟,值為 Y/N,Y 為開啟
goods Array 道具打賞,道具物件數量必須大於 0 且小於 10【詳見ChannelGood 參數說明
appId String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
ChannelGood參數描述
參數名 必選 類型 說明
goodName true String 道具名稱,不能超過5個字元
goodImg true String 道具圖片,不能超過120個字元(透過上傳圖片介面上傳取得圖片位址,或使用預設位址;鮮花:01-flower.png;咖啡:02-coffee.png;點讚:03-good.png;掌聲:04-applaud.png;666:05-666.png;小星星:06-star.png;鑽石:07-diamond.png;跑車:08-car.png;火箭:09-rocket.png;前綴統一為://livestatic.videocc.net/uploaded/images/webapp/channel/donate/)
goodPrice true Double 道具打賞價格
goodEnabled true String 道具開關,值為 Y/N,Y 為開啟

回傳物件描述

true 代表設定成功,false 代表設定失敗




2、設定現金打賞

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

2、帶上頻道號為設定頻道現金打賞,不帶頻道號預設為全域現金打賞設定

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求參數說明

參數名 必選 類型 說明
channelId false String 頻道號,不傳則為全域設定
cashes true Array 請求體參數,現金打賞數額陣列,陣列長度必須為6
cashMin true Double 請求體參數,現金打賞自訂最小金額
enabled false String 請求體參數,現金打賞開關,不傳則預設開啟,值為 Y/N,Y 為開啟
appId false String POLYV 用戶 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 用戶 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

true 表示設定成功,false 表示設定失敗




3、查詢打賞設定

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveChannelDonateResponse 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請參閱 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求參數說明

參數名 必選 類型 說明
channelId false String 頻道號,不傳則為取得全域設定
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

參數名 類型 說明
globalSettingEnabled String 是否套用全域設定,取得全域設定時,該值為 null
donateCashEnabled String 現金打賞開關
donateGoodEnabled String 道具打賞開關
donateTips String 打賞提示
cashes Array 請求體參數,現金打賞數額陣列,陣列長度必須為 6
cashMin Double 請求體參數,現金打賞自訂最小金額
goods Array 道具打賞【詳見 ChannelGood 參數說明
ChannelGood參數描述
參數名 類型 說明
goodName String 道具名稱,不能超過5個字元
goodImg String 道具圖片,不能超過120個字元(透過上傳圖片介面上傳取得圖片位址,或使用預設位址;鮮花:01-flower.png;咖啡:02-coffee.png;按讚:03-good.png;掌聲:04-applaud.png;666:05-666.png;小星星:06-star.png;鑽石:07-diamond.png;跑車:08-car.png;火箭:09-rocket.png;前綴統一為://livestatic.videocc.net/uploaded/images/webapp/channel/donate/)
goodPrice Double 道具打賞價格
goodEnabled String 道具開關,值為 Y/N,Y 為開啟






4、設定頻道微信分享資訊

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因:invalid signature. ]

請求參數說明

參數名 必選 類型 說明
channelId true String 頻道號
wxShareTitle false String 微信分享的標題(30字元內)【對應 API 文件的 weixinShareTitle 欄位】
wxShareDesc false String 微信分享的描述(120字元內)【對應 API 文件的 weixinShareDesc 欄位】
appId false String POLYV 用戶 APP_ID,多帳號調用時此參數必填(即調用了 initMultiAccount() 設定多帳號調用),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 用戶 APP_SECRET,多帳號調用時此參數必填(即調用了 initMultiAccount() 設定多帳號調用),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

true 為設定成功,false 為設定失敗




5、查詢頻道微信分享資訊

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveGetChannelWxShareResponse 物件,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() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網 -> 登入 -> 直播(開發設定)

回傳物件描述

參數名 類型 說明
channelId String 頻道號
channelName String 頻道名稱
coverImg String 微信分享圖示,即頻道的直播圖示
wxShareTitle String 微信分享的標題【對應 API 文件的 weixinShareTitle 欄位】
wxShareDesc String 微信分享的描述【對應 API 文件的 weixinShareDesc 欄位】






6、查詢頻道打賞設定

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveGetChannelDonateResponse 物件,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() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網 -> 登入 -> 直播(開發設定)

回傳物件描述

參數名 類型 說明
donateCashEnabled String 現金紅包打賞開關,Y:開啟,N:關閉
cashDonate ChannelCashDonate 現金紅包【詳見ChannelCashDonate參數說明
donateGiftEnabled String 禮物打賞開關,Y:開啟,N:關閉
giftDonate Array 禮物打賞(現金支付或積分支付)【詳見ChannelGiftDonate參數說明
ChannelCashDonate參數描述
參數名 類型 說明
cashes Array 固定打賞金額,陣列長度在1-6,最小值0.01,最大值9999.99【對應API文件的cashs欄位】
cashMin Float 自訂打賞金額-最低金額,最小值0.01,最大值9999.99
ChannelGiftDonate參數描述
參數名 類型 說明
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:關閉






7、修改頻道禮物打賞設定

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請參閱 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參說明

參數名 必填 類型 說明
channelId true String 頻道號
donateGiftEnabled false String 禮物打賞開關,Y:開啟,N:關閉
giftDonate false ChannelGiftDonate 禮物打賞(現金支付或積分支付)【詳見ChannelGiftDonate參數描述
appId false String POLYV用戶APP_ID,多帳號調用時此參數必填(即調用了initMultiAccount()設定多帳號調用),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV用戶APP_SECRET,多帳號調用時此參數必填(即調用了initMultiAccount()設定多帳號調用),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
ChannelGiftDonate參數描述
參數名 必選 類型 說明
payWay false String 支付方式,CASH:現金支付,POINT:積分支付
cashUnit false String 現金單位
pointUnit false String 積分單位
cashPays false Array 現金支付列表【詳見ChannelGift參數描述
pointPays false Array 積分支付列表【詳見ChannelGift參數描述
ChannelGift參數描述
參數名 必選 類型 說明
name false String 禮物名稱
img false String 禮物圖片位址
price false Float 禮物價格
enabled false String 開關,Y:開啟,N:關閉
ChannelGift參數描述
參數名 必選 類型 說明
name false String 禮物名稱
img false String 禮物圖片位址
price false Float 禮物價格
enabled false String 開關,Y:開啟,N:關閉

回傳物件描述

修改頻道禮物打賞設定回傳實體




8、查詢頻道卡片推送

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveGetChannelCardPushResponse 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參說明

參數名 必填 類型 說明
channelId true String 頻道ID
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

回傳物件是List<LiveGetChannelCardPushResponse>,LiveGetChannelCardPushResponse具體元素內容如下:

參數名 類型 說明
id Long 卡片推送主鍵ID
channelId String 頻道ID
title String 卡片標題,最多16個字元
imageType String 卡片樣式類型,giftbox:禮物領取樣式,redpack:紅包樣式
duration Integer 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長
link String 卡片跳轉連結位址,帶http://等协议头
pushEndTime Date 推送結束時間
createdTime Date 建立時間
lastModified Date 修改時間
pushStatus String 推送狀態Y.推送中、N.未推送、L.上次推送
pushTime Date 推送時間
enterEnabled String 卡片入口Y.開啟、N.關閉
showCondition String 彈出方式,PUSH.推送後立即彈出、WATCH.觀看後彈出
conditionValue Integer 觀看時長
conditionUnit String 觀看時長單位SECONDS.秒、MINUTES.分鐘
countdownMsg String 倒數計時文案,showCondition為WATCH時生效,最多8個字元






9、建立頻道卡片推播

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveCreateChannelCardPushResponse 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參描述

參數名 必選 類型 說明
channelId true String 頻道號
imageType true String 卡片樣式類型,giftbox:禮物領取樣式,redpack:紅包樣式
title true String 卡片標題,最多16個字元
link true String 卡片跳轉連結位址,需帶有http:等協定頭
duration true Integer 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長
showCondition true String 彈出方式,PUSH:推送後立即彈出、WATCH:觀看後彈出
conditionValue false Integer 觀看後彈出的觀看時長,showCondition為WATCH時生效
conditionUnit false String 觀看後彈出的觀看時長單位SECONDS.秒、MINUTES.分鐘,showCondition為WATCH時,該值生效且必填
countdownMsg false String 倒數計時文案,showCondition為WATCH時生效,最多8個字元
enterEnabled true String 卡片入口開關Y.開啟、N.關閉
appId false String POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

參數名 類型 說明
id Long 卡片推送主鍵ID
channelId String 頻道ID
title String 卡片標題,最多16個字元
imageType String 卡片樣式類型,giftbox:禮物領取樣式,redpack:紅包樣式
duration Integer 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長
link String 卡片跳轉連結位址,帶http:等協定頭
pushEndTime Date 推送結束時間
createdTime Date 建立時間
lastModified Date 修改時間
pushStatus String 推送狀態Y.推送中、N.未推送、L.上次推送
pushTime Date 推送時間
enterEnabled String 卡片入口Y.開啟、N.關閉
showCondition String 彈出方式,PUSH.推送後立即彈出、WATCH.觀看後彈出
conditionValue Integer 觀看時長
conditionUnit String 觀看時長單位SECONDS.秒、MINUTES.分鐘
countdownMsg String 倒數計時文案,showCondition為WATCH時生效,最多8個字元






10、修改頻道卡片推播

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求參數說明

參數名 必選 類型 說明
channelId true String 頻道號
cardPushId true Long 卡片推送主鍵ID
imageType false String 卡片樣式類型,giftbox:禮物領取樣式,redpack:紅包樣式
title false String 卡片標題,最多16個字元
link false String 卡片跳轉連結位址,需帶http:等協定頭
duration false Integer 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長
showCondition false String 彈出方式,PUSH:推送後立即彈出、WATCH:觀看後彈出
conditionValue false Integer 觀看後彈出的觀看時長,showCondition為WATCH時生效
conditionUnit false String 觀看後彈出的觀看時長單位SECONDS.秒、MINUTES.分鐘,showCondition為WATCH時,該值生效且必填
countdownMsg false String 倒數計時文案,showCondition為WATCH時生效,最多8個字元
enterEnabled false String 卡片入口開關Y.開啟、N.關閉
appId false String POLYV用戶APP_ID,多帳號調用時該參數必填(即調用了initMultiAccount()設置多帳號調用),通過註冊保利威官網獲取,路徑:官網->登入->直播(開發設置)
appSecret false String POLYV用戶APP_SECRET,多帳號調用時該參數必填(即調用了initMultiAccount()設置多帳號調用),通過註冊保利威官網獲取,路徑:官網->登入->直播(開發設置)

回傳物件描述

修改頻道卡片推送回傳實體




11、刪除卡片推播

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參描述

參數名 必選 類型 說明
channelId true String 頻道號
cardPushId true Long 卡片推送主鍵ID
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

刪除卡片推送回傳實體




12、推播頻道卡片

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求返回資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參說明

參數名 必選 類型 說明
channelId true String 頻道號
cardPushId true Long 卡片推送主鍵ID
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

推送頻道卡片回傳實體




13、取消推播卡片

描述

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

呼叫限制

1、介接呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參描述

參數名 必選 類型 說明
channelId true String 頻道號
cardPushId true Long 卡片推送主鍵ID
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

取消推播卡片返回實體




14、查詢頻道微信分享資訊

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 LiveGetChannelShareResponse 物件,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() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

參數名 類型 說明
shareBtnEnable String 是否開啟分享,Y:開啟,N:關閉
titleType String 標題類型 follow 直播標題、custom 自訂
weixinShareTitle String 分享標題,最大長度 50,標題類型為 custom 時,該欄位生效
weixinShareDesc String 分享簡介,最大長度 120,標題類型為 custom 時,該欄位生效
weixinShareCustomUrl String 微信自訂分享地址,最大長度 512
webShareCustomUrl String 網頁觀看自訂分享地址,最大長度 512






15、修改頻道微信分享資訊

描述

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

呼叫限制

1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看

單元測試

    @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;
        }
    }

單元測試說明

1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;

2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]

請求入參說明

參數名 必選 類型 說明
channelId true String 頻道號
shareBtnEnable true String 是否開啟分享,Y:開啟,N:關閉
titleType true String 標題類型:follow 直播標題、custom 自訂
weixinShareTitle false String 分享標題,最大長度 50,標題類型為 custom 時,此欄位必填
weixinShareDesc false String 分享簡介,最大長度 120,標題類型為 custom 時,此欄位必填
weixinShareCustomUrl false String 微信自訂分享地址,最大長度 512,連結必須帶協定,如:https://,链接需要进行encode
webShareCustomUrl false String 網頁觀看自訂分享地址,最大長度 512,連結必須帶協定,如:https://,链接需要进行encode
appId false String POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)
appSecret false String POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定)

回傳物件描述

修改頻道微信分享資訊回傳實體

联系客服,在线咨询