webSetting
1、設定頻道預設項目開關
描述
设置频道默认项开关
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/common/update-global-enabled
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetChannelGlobalSwitch() throws Exception, NoSuchAlgorithmException {
LiveChannelGlobalSwitchRequest liveChannelGlobalSwitchRequest = new LiveChannelGlobalSwitchRequest();
Boolean liveChannelGlobalSwitchResponse;
try {
liveChannelGlobalSwitchRequest.setChannelId(createChannel())
.setGlobalEnabledType(LiveConstant.GlobalEnabledType.CALLBACK.getDesc())
.setEnabled("N");
liveChannelGlobalSwitchResponse = new LiveWebSettingServiceImpl().setChannelGlobalSwitch(
liveChannelGlobalSwitchRequest);
Assert.assertNotNull(liveChannelGlobalSwitchResponse);
if (liveChannelGlobalSwitchResponse) {
//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 | 頻道號 |
| globalEnabledType | true | String | 功能類型 auth:觀看條件設定;觀看頁管理-觀看條件 switch:功能開關設定;直播間管理-功能開關 marquee:跑馬燈設定;播放器管理-防錄影跑馬燈 restrict:播放限制設定;播放器管理-播放限制 donate:打賞設定;觀看頁管理-打賞設定 advert:廣告設定;觀看頁管理-行銷設定-廣告 callback:回呼設定; player:播放器設定 |
| enabled | true | String | 功能開關 Y:開啟 N:關閉 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件說明
true 為設定成功,false 為設定失敗
2、上傳圖片資源
描述
接口用于上传接口所需图片,同时获取图片地址。图片地址可用于 设置道具打赏 goodImg字段等。
接口地址(仅做说明使用):https://api.polyv.net/live/v3/common/upload-image
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testUploadImage() throws Exception, NoSuchAlgorithmException {
LiveUploadImageRequest liveUploadImageRequest = new LiveUploadImageRequest();
LiveUploadImageResponse liveUploadImageResponse;
try {
String path = getClass().getResource("/img/elephant.png").getPath();
List<File> fileList = new ArrayList<File>();
fileList.add(new File(path));
liveUploadImageRequest.setType("coverImage")
.setFile(fileList);
liveUploadImageResponse = new LiveWebSettingServiceImpl().uploadImage(
liveUploadImageRequest);
Assert.assertNotNull(liveUploadImageResponse);
if (liveUploadImageResponse != null) {
//to do something ......
log.debug("测试上传图片资源成功,{}",liveUploadImageResponse);
}
} 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、請求正確,回傳 LiveUploadImageResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| type | true | String | 上傳圖片類型 coverImage:頻道圖示,建議 140 x 140 大小的圖示,檔案大小不超過 2M。 splashImage:直播引導圖,建議 750 x 1334 大小的圖片,大小不超過 2M。 logoImage:播放器 logo,建議不大於 140 x 50 大小的圖片,檔案大小不超過 2M。 adminAvatar:聊天室管理員頭像,建議 140 x 140 大小的圖示,檔案大小不超過 2M。 assistantAvatar:助教頭像,建議 140 x 140 大小的圖示,檔案大小不超過 2M。 authCodeImage:授權觀看 QR Code 圖片, 最大不超過 200K。 warmImage:暖場圖片, 建議 1280 x 720,圖片大小不超過 2M。 adImage:廣告欄圖片,建議 750 x 120,最大不超過 2 M。 startAdImage:片頭廣告圖片,建議 1280 x 720 大小的圖片 ,檔案大小不超過 4 M。 stopAdImage:暫停廣告圖片,建議 1280 x 720 大小的圖片 ,檔案大小不超過 4 M。 goodImage:打賞圖示,建議 180 x 180 大小的圖示,檔案大小不超過 300 k。 invitationImage:邀請卡圖片,建議 750 x 1334 大小的圖片,大小不超過 4 M。 menuImage:頻道選單圖片, 最大不能超過為 2M。 |
| file | true | Array | 圖片檔案列表,支援同時上傳不超過 6 個 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| imgUrls | Array | 圖片連結位址列表 |
