保利威文档中心

幫助中心

建立MR頻道

更新時間:2023-12-04 17:25:11

介面說明

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

介面URL

http://api.polyv.net/live/v4/channel/mr/create

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

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

請求主體參數說明

參數名稱 必填 類型 說明
name true String 直播名稱,最大長度100
categoryId false Integer 分類ID
startTime false Long 開始時間,13位毫秒級時間戳記【註:僅做直播前倒數計時顯示,不對講師開播操作產生影響】
channelPasswd false String MR控制台密碼,長度6-16位,必須同時包含字母和數字,不傳則由系統隨機產生
assistantPasswd false String MR直播助理角色密碼,長度6-16位,必須同時包含字母和數字,不傳則由系統隨機產生
splashImg false String 引導頁圖片網址,非保利威域名下的圖片需先呼叫上傳頻道所有裝潢圖片素材上傳
subAccount false String 子帳號信箱,提交後,該頻道帳號在後台擁有的權限會跟隨該子帳號的頻道權限

範例

http://api.polyv.net/live/v4/channel/mr/create?appId=frlr1zazn3&sign=ECFC0A76E357F3EF2D1110BEB92C1045&timestamp=1659063884736

請求主體json參數:

{
    "name": "MR直播测试频道",
    "startTime": "1779254040000",
    "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg"
}

回應參數說明

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

Error參數說明

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

data參數說明

參數名稱 類型 說明
channelId String 頻道ID
name String 頻道名稱
userId String 直播帳號userId
channelPasswd String MR直播-控制台登入密碼
assistantAccount String MR直播-直播助理帳號
assistantPasswd String MR直播-直播助理登入密碼

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建MR频道
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCreateMrChannel() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/mr/create";
    
    String name = "MR直播接口测试";
    String categoryId = "391352";
    Long startTime = new Date().getTime() + 30 * 60 * 1000l;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, String> bodyMap = new HashMap<>();
    bodyMap.put("name", name);
    bodyMap.put("categoryId", categoryId);
    bodyMap.put("startTime", String.valueOf(startTime));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String body = JSON.toJSONString(bodyMap);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    
    log.info("测试创建MR频道成功:{}", response);
    //do somethings
}

回應範例

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

成功範例(測試範例頻道號已隱藏)

{
    "code": 200,
    "status": "success",
    "requestId": "ddf972812a804e0ba9122fd721274592.69.16590638894645319",
    "data": {
        "channelId": ******,
        "name": "MR直播接口测试",
        "userId": "1b448be323",
        "channelPasswd": "9cNkSc",
        "assistantAccount": "0013265559",
        "assistantPasswd": "38kYPY"
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询