invitePosterService
1、查詢邀請海報明細資料
描述
分页查询邀请海报明细数据统计
接口地址(仅做说明使用):https://api.polyv.net/live/v4/channel/invite/list
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testGetInviteStats() throws IOException, NoSuchAlgorithmException {
LiveGetInviteStatsRequest liveGetInviteStatsRequest = new LiveGetInviteStatsRequest();
LiveGetInviteStatsResponse liveGetInviteStatsResponse;
try {
String channelId = super.getAloneNewChannelId();
liveGetInviteStatsRequest.setChannelId(channelId)
.setStartTime(super.getDate(1651219474000L))
.setEndTime(super.getDate(1651219478000L));
liveGetInviteStatsResponse = new ILiveInvitePosterServiceImpl().getInviteStats(liveGetInviteStatsRequest);
Assert.assertNotNull(liveGetInviteStatsResponse);
if (liveGetInviteStatsResponse != null) {
//to do something ......
log.debug("测试查询邀请海报明细数据成功 {}", JSON.toJSONString(liveGetInviteStatsResponse));
}
} 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、請求正確,回傳 LiveGetInviteStatsResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| startTime | false | Date | 受邀開始時間 |
| endTime | false | Date | 受邀結束時間 |
| currentPage | false | Integer | 頁數,預設為 1【對應 API 文件的 pageNumber 欄位】 |
| pageSize | false | Integer | 每頁顯示的資料筆數,預設每頁顯示 20 筆資料 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| contents | Array | 目前頁內容【詳見 InviteStats 參數描述】 |
| pageSize | Integer | 每頁顯示的資料筆數,預設每頁顯示 20 筆資料 |
| currentPage | Integer | 目前頁【對應 API 文件的 pageNumber 欄位】 |
| totalItems | Integer | 記錄總筆數 |
| totalPage | Integer | 總頁數【對應 API 文件的 totalPages 欄位】 |
InviteStats 參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| invitee | String | 自訂邀請 ID(預設為空,需設定才有值) |
| openId | String | 邀請人微信 openId |
| viewerId | String | 邀請人 ViewerID |
| nickname | String | 邀請人暱稱 |
| avatar | String | 邀請人頭像 url |
| createdTime | Date | 海報產生時間,13 位毫秒級時間戳 |
| receiverNickname | String | 受邀人暱稱 |
| receiverOpenId | String | 受邀人微信 openId |
| receiverViewerId | String | 受邀人 ViewerId |
| receiverTime | Date | 受邀時間,13 位毫秒級時間戳 |
| receiverAvatar | String | 受邀人頭像 url |
2、建立邀請者
描述
邀请海报-创建邀请者
接口地址(仅做说明使用):https://api.polyv.net/live/v4/channel/invite/poster/create
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testCreateInviter() throws IOException, NoSuchAlgorithmException {
LiveCreateInviterRequest liveCreateInviterRequest = new LiveCreateInviterRequest();
LiveCreateInviterResponse liveCreateInviterResponse;
try {
String channelId = super.createChannel();
liveCreateInviterRequest.setChannelId(channelId);
liveCreateInviterRequest.setOpenId("1yexRmHZoJrcw40");
liveCreateInviterRequest.setNickname("张三");
liveCreateInviterResponse = new ILiveInvitePosterServiceImpl().createInviter(liveCreateInviterRequest);
Assert.assertNotNull(liveCreateInviterResponse);
if (liveCreateInviterResponse != null) {
//to do something ......
log.debug("测试创建邀请者成功 {}", JSON.toJSONString(liveCreateInviterResponse));
}
} 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、請求正確,回傳 LiveCreateInviterResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| openId | true | String | 邀請者使用者 ID |
| nickname | true | String | 邀請者暱稱 |
| avatar | false | String | 邀請者頭像 url 地址,如果為空,則使用預設頭像 |
| viewerId | false | String | 邀請者觀眾 ID |
| invitee | false | String | 自訂邀請 ID |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| invitePosterId | String | 邀請海報 ID |
| channelId | String | 頻道 ID |
| openId | String | 邀請者使用者 ID |
| invitee | String | 自訂邀請 ID |
