保利威文档中心

幫助中心

分配子帳號資源

更新時間:2022-09-02 18:08:07

介面描述

1、分配分帐号资源
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/group/user/package-validity/update

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret

3、子帳號用量計費套餐跟隨集團主帳號,分鐘數計費只能分配分鐘數,並發計費只能分配並發數

4、設定資源有效期需要帳號擁有該資源,且到期日期需大於啟用日期,啟用日期需大於等於當天

5、傳了並發數時,並發啟用日期、並發到期日期必填;可用分鐘數、點播流量、點播空間亦然

請求參數描述

參數名 必選 類型 說明
appId true String 集團主帳號appId
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料的安全關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則

請求體參數描述

參數名 必選 類型 說明
email true String 子帳號信箱
balance false Float 金額,不能小於0
concurrent false Integer 並發數
concurrentActivateDate false Long 並發啟用日期,13位毫秒級時間戳,只取年月日
concurrentEndDate false Long 並發到期日期,13位毫秒級時間戳,只取年月日
minutes false Integer 可用分鐘數(分)
minutesActivateDate false Long 可用分鐘數啟用日期,13位毫秒級時間戳,只取年月日
minutesEndDate false Long 可用分鐘數到期日期,13位毫秒級時間戳,只取年月日
remainFlow false Integer 點播流量,單位G
remainFlowActivateDate false Long 點播流量啟用日期,13位毫秒級時間戳,只取年月日
remainFlowEndDate false Long 點播流量到期日期,13位毫秒級時間戳,只取年月日
remainSpace false Integer 點播空間,單位G
remainSpaceActivateDate false Long 點播空間啟用日期,13位毫秒級時間戳,只取年月日
remainSpaceEndDate false Long 點播空間到期日期,13位毫秒級時間戳,只取年月日
linkMicLimit false Integer 連麥人數限制,最多16人
linkMicMinutes false Integer 連麥分鐘數
guideMinutes false Integer 雲導播台分鐘數
maxChannels false Integer 可建立頻道數

範例

http://api.polyv.net/live/v4/group/user/package-validity/update?appId=gc3eo6bh28&timestamp=1660214092000&sign=61250FACAC4A0091294CFE81CA4E2973

請求體參數

{
    "email": "grouptest0501@polyv.net",
    "remainFlow": 10,
    "remainFlowEndDate": 1662825600000,
    "remainSpace": 5,
    "remainSpaceEndDate": 1665763200000,
    "remainSpaceActivateDate": 1663171200000
}

回應參數描述

參數名 類型 說明
code Integer 狀態碼,與http狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一UUID,僅可用於排查、除錯,不應該和業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位描述
data Boolean 請求成功回傳true,請求失敗回傳空

Error參數描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與error.code對應

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。


回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "71c487ed89a94ca0b29e8779ea96f84b.63.16529473248590749",
    "data": true,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}
联系客服,在线咨询