userService
1、查詢分帳號列表及剩餘資源
描述
集团账号查询分账号列表及分账号剩余资源
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/package/list
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testListPackage() throws IOException, NoSuchAlgorithmException {
GroupListPackageRequest groupListPackageRequest = new GroupListPackageRequest();
GroupListPackageResponse groupListPackageResponse;
try {
groupListPackageResponse = new UserServiceImpl().listPackage(groupListPackageRequest);
Assert.assertNotNull(groupListPackageResponse);
if (groupListPackageResponse != null) {
//to do something ......
log.debug("测试查询分账号列表及剩余资源成功 {}", JSON.toJSONString(groupListPackageResponse));
}
} 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、請求正確,回傳 GroupListPackageResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| emails | false | String | 分帳號信箱,多個以英文逗號分隔,最多 100 個 |
| pageSize | false | Integer | 每頁資料筆數,預設 10,最大值 100 |
| pageNumber | false | Integer | 目前頁數,預設 1 |
回傳物件說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| contents | Array | 帳單列表【詳見Package 參數說明】 |
| pageSize | Integer | 每頁顯示的資料筆數,預設每頁顯示 20 筆資料 |
| currentPage | Integer | 目前頁【對應 API 文件的 pageNumber 欄位】 |
| totalItems | Integer | 記錄總筆數 |
| totalPage | Integer | 總頁數【對應 API 文件的 totalPages 欄位】 |
Package 參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| userId | String | 使用者 ID |
| appId | String | 分帳號應用 ID |
| appSecret | String | 分帳號應用 secret |
| String | 分帳號信箱 | |
| balance | String | 剩餘金額 |
| phone | String | 手機號碼 |
| memo | String | 備註 |
| contacts | String | 聯絡人 |
| chargeType | String | 雲直播計費類型 minutes:分鐘數 parallelConcurrent:並行並發 totalConcurrent:累計並發 |
| remainConcurrent | Long | 雲直播剩餘資源,並發 |
| remainMinutes | Long | 雲直播剩餘資源,可用直播分鐘數 |
| remainFlow | Float | 雲點播剩餘資源,流量(G) |
| remainSpace | Float | 雲點播剩餘資源,空間(G) |
| expireType | String | 到期時間類型 group:跟隨主帳號 custom:自訂 |
| expireDate | Long | 帳號到期時間,十三位時間戳 |
| status | String | 狀態 normal:正常使用 expired:已過期 frozen:已凍結 |
| linkMicMinutes | Integer | 可用連麥分鐘數 |
| guideMinutes | Integer | 可用雲導播台分鐘數 |
| maxChannels | Integer | 可建立頻道數 |
| linkMicLimit | Integer | 連麥人數 |
| vodSecretKey | String | 點播 secretkey |
| vodBakSecretKey | String | 點播備用 secretkey |
| writeToken | String | 點播 writetoken |
| readToken | String | 點播 readtoken |
2、建立集團分帳號
描述
创建集团分帐号
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/create
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testCreate() throws IOException, NoSuchAlgorithmException {
GroupCreateUserRequest groupCreateUserRequest = new GroupCreateUserRequest();
GroupCreateUserResponse groupCreateUserResponse;
try {
groupCreateUserRequest.setEmail("polyvtest0707@polyv.net");
groupCreateUserRequest.setPassword("polyvtest0707");
groupCreateUserRequest.setContacts("张三");
groupCreateUserRequest.setPhone("17600002222");
groupCreateUserRequest.setExpireDate(super.getDate(1688720314000L));
groupCreateUserRequest.setMaxChannels(1);
groupCreateUserRequest.setConcurrent(10);
groupCreateUserResponse = new UserServiceImpl().create(groupCreateUserRequest);
Assert.assertNotNull(groupCreateUserResponse);
if (groupCreateUserResponse != null) {
//to do something ......
log.debug("测试创建集团分帐号成功 {}", JSON.toJSONString(groupCreateUserResponse));
}
} 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、請求正確,回傳 GroupCreateUserResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| true | String | 信箱 | |
| password | true | String | 密碼,需同時包含數字、英文,長度 8~32 位 |
| contacts | true | String | 聯絡人 |
| phone | true | String | 手機號碼,手機號不能綁定超過 3 個信箱 |
| maxChannels | true | Integer | 最多可建立頻道數量 |
| minutes | false | Integer | 分鐘數,主帳號為分鐘數計費,此用量值必填 |
| concurrent | false | Integer | 並發數,主帳號為並發計費,此用量值必填 |
| balance | false | Float | 金額,不能小於 0 |
| memo | false | String | 備註,50 字元長度 |
| expireType | false | String | 到期時間類型 group:跟隨主帳號 custom:自訂 |
| expireDate | false | Date | 帳號過期時間,yyyy-MM-dd,如 2022-04-28 |
| remainFlow | false | Integer | 點播流量,單位 G,預設分配 100G |
| remainSpace | false | Integer | 點播空間,單位 G,預設分配 100G |
回傳物件說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| appId | String | 應用 ID |
| appSecret | String | 應用 Secret |
| userId | String | 使用者全域 ID |
3、分配分帳號資源
描述
分配分帐号资源
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/package/update
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testUpdatePackage() throws IOException, NoSuchAlgorithmException {
GroupUpdatePackageRequest groupUpdatePackageRequest = new GroupUpdatePackageRequest();
Boolean groupUpdatePackageResponse;
try {
groupUpdatePackageRequest.setEmail("polyvtest0625@polyv.net");
groupUpdatePackageRequest.setBalance(2f);
groupUpdatePackageRequest.setConcurrent(5);
groupUpdatePackageRequest.setRemainFlow(10);
groupUpdatePackageRequest.setRemainSpace(10);
groupUpdatePackageResponse = new UserServiceImpl().updatePackage(groupUpdatePackageRequest);
Assert.assertNotNull(groupUpdatePackageResponse);
if (groupUpdatePackageResponse != null) {
//to do something ......
log.debug("测试分配分帐号资源成功 {}", JSON.toJSONString(groupUpdatePackageResponse));
}
} 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. ]
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| true | String | 分帳號信箱 | |
| balance | false | Float | 金額,不能小於 0 |
| concurrent | false | Integer | 並發數 |
| minutes | false | Integer | 可用分鐘數(分) |
| remainFlow | false | Integer | 點播流量,單位 G |
| remainSpace | false | Integer | 點播空間,單位 G |
| linkMicLimit | false | Integer | 連麥人數限制,最多 16 人 |
| linkMicMinutes | false | Integer | 連麥分鐘數 |
| guideMinutes | false | Integer | 雲導播台分鐘數 |
| maxChannels | false | Integer | 可建立頻道數 |
回傳物件說明
true 為分配成功,false 為分配失敗
