騰訊雲政企直播下單介面
更新時間:2023-04-04 09:31:23
介面描述
1、该接口接收用户购买信息,通知保利威工作人员,由工作人员线下开通账号。
2、(timestamp, appId, signatureNonce)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
http://api.polyv.net/live/v4/root/order/create
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、基礎服務、加值服務至少包含一項,否則會回傳異常;
3、一次性校驗參數signatureNonce,用於防止網路重放攻擊;
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 企業級appId,由保利威提供 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,其中appSecret為企業級appSecret,由保利威提供,為32位大寫的MD5值【詳見簽名產生規則】 |
請求體參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| UIN | true | String | 騰訊帳號識別碼,最大長度30 |
| orderId | true | String | 訂單號,訂單號重複將拋出異常,error.code=35002,最大長度70 |
| true | String | 客戶信箱,最大長度30 | |
| mobile | true | String | 客戶手機號碼,長度11 |
| contact | false | String | 客戶姓名,長度30 |
| basicService | false | Array | 基礎服務【詳見BasicService參數描述】,基礎服務、加值服務至少包含一項 |
| premiumService | false | Array | 加值服務【詳見PremiumService參數描述】,基礎服務、加值服務至少包含一項 |
BasicService參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| type | true | String | 基礎服務類型【詳見基礎服務類型說明】, standard:標準版; enterprise:企業版; flagship:旗艦版; |
| number | Integer | 續費時長,單位:年 |
PremiumService參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| type | true | String | 加值服務類型【詳見加值服務類型說明】, premium_package:加值擴充包,單位:個; group_account:集團帳號,單位:年; quality_analysis:品質分析,單位:年; live_transfer:直播轉推,單位:次; link_mic_time:雲直播連麥,單位:分鐘; playback_store:回放儲存,單位:GB; playback_flow:回放流量,單位:GB; channel_number:頻道個數,單位:個; live_time:直播分鐘數,單位:分鐘; monitoring_time:導播台分鐘數,單位:分鐘; |
| number | true | Integer | 續費數量 |
基礎服務類型說明
| 類型代碼 | 服務類型 | 功能描述 | 單位 |
|---|---|---|---|
| standard | 標準版 | 直播系統產品平台,包含100萬分鐘(1年有效),200個頻道號直播系統產品平台,包含100萬分鐘(1年有效),200個頻道號 | 年 |
| enterprise | 企業版 | 250萬分鐘,一年有效期,500個頻道號 | 年 |
| flagship | 旗艦版 | 500萬分鐘,一年有效期,1000個頻道號 | 年 |
加值服務類型說明
| 類型代碼 | 服務類型 | 功能描述 | 單位 |
|---|---|---|---|
| premium_package | 加值擴充包 | 直播系統產品平台,包含100萬分鐘(1年有效),200個頻道號直播系統產品平台,包含100萬分鐘(1年有效),200個頻道號 | 年 |
| group_account | 集團帳號 | 集團帳號可以建立多個分帳號,並可對這些分帳號分配或回收分鐘數、流量和空間 | 年 |
| quality_analysis | 品質分析 | 從雷達圖中,從上方逆時針分別顯示4個指標:直播觀看熱情、直播回看情況、觀看專注程度、觀看互動 | 年 |
| live_transfer | 直播轉推 | 透過保利威開播後,可以透過多路轉推服務,支援將本地直播推流到第三方平台(如:鳳凰網、bilibili、微信影片號、愛奇藝)進行推廣,擴大直播的宣傳度和影響力。同時往多個平台轉推直播內容,一般用於多平台推廣,達到更好的直播傳播效果 | 次 |
| link_mic_time | 雲直播連麥 | 即遠端直播連麥,主講與觀眾可進行即時音視訊連麥,零延遲互動,最多可支援17人連麥 | 分鐘 |
| playback_store | 回放儲存 | 空間:指直播回放的影片轉存到點播的影片大小,按年度計費 | GB |
| playback_flow | 回放流量 | 流量:播放回放影片所產生的流量 | GB |
| channel_number | 頻道號 | 指直播房間號,可以重複開多場直播 | 個 |
| live_time | 直播分鐘數 | 使用者可觀看直播的時長 | 分鐘 |
| monitoring_time | 導播台 | 導播台可預覽直播畫面,支援多畫面切換、延遲直播,一方面可隨需切換視訊訊號,另一方面也為直播活動的意外情況做足備案 | 分鐘 |
範例
http://api.polyv.net/live/v4/root/order/create?appId=frlr1zazn3&sign=E3F501CFEF5FCCF2DF9BFDCE9C91F48C×tamp=1629445373947
請求體json參數:
{
"orderId":"20999126-2c9d-4d3b-9438-c2945161d252",
"email":"admin@polyv.net",
"mobile":"18888888888",
"contact":"张三",
"basicService":{
"type":"flagship",
"number":1
},
"premiumService":[
{
"type":"",
"number":""
}
]
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤 |
| data | Boolean | 請求回應物件,成功回傳true,失敗回傳false |
| error | Object | 錯誤資訊【詳見Error參數描述】 |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "847f0716fa76461baf8979aaa4415dc3.67.16342672396023837",
"data": true,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
