保利威文档中心

幫助中心

建立研討會頻道(新版後台)

更新時間:2026-04-09 17:41:40

舊版介面位址建立單一頻道(舊版)

舊版介面升級新版注意事項

1、舊版介面建立頻道時,能直接設定頻道基本資訊、對外研討時的觀看條件
2、新版介面建立頻道時,只能設定頻道基本資訊,觀看條件來源於預設模板設定,在建立頻道前需設定好預設模板;
3、預設模板的修改不會對已建立的頻道產生影響,已建立頻道資訊的修改與舊版介面一致;

介面描述

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

2、研討會場景下主持人密碼和與會人密碼不能相同;

請求參數描述

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

請求體參數描述

參數名 必選 類型 說明
name true String 直播名稱,最大長度100
newScene true String 直播場景 (seminar-研討會)
seminarHostPassword false String 研討會主持人密碼,僅直播場景是研討會時有效,長度6-16位,不傳則由系統隨機產生。研討會主持人密碼和與會人密碼不能相同。
seminarAttendeePassword false String 研討會與會人密碼,僅直播場景是研討會時有效,長度6-16位,不傳則由系統隨機產生。研討會主持人密碼和與會人密碼不能相同。
recordMode false String 錄製方式,僅直播場景是研討會時有效。auto 自動錄製(預設);manual 手動錄製
seminarLiveType false String 會議類型,僅直播場景是研討會時有效。private 對內研討(預設);public 對外直播
splashImg false String 封面圖片位址,非保利威域名下的圖片需呼叫上傳頻道所有裝潢圖片素材上傳
categoryId false Integer 分類ID,可透過「查詢直播分類」介面取得
startTime false Long 開始時間,時間戳,如:1629734400000
subAccount false String 子帳號信箱,填寫時頻道會建立在該子帳號下(子帳號不能被刪除或停用),暫無法透過介面取得
linkMicLimit false Integer 與會人數
1-47:代表與會人數

範例

http://api.polyv.net/live/v4/channel/create?appId=frlr1zazn3&sign=E3F501CFEF5FCCF2DF9BFDCE9C91F48C&timestamp=1629445373947

請求體json參數:

{
  "name": "polyv研讨会",
  "newScene": "seminar",
  "recordMode": "auto",
  "seminarLiveType": "private",
  "seminarHostPassword": "hostpasswd",
  "seminarAttendeePassword": "attendeepasswd"
}

回應參數描述

參數名 類型 說明
code Integer 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤
data Object 頻道回應物件【詳見data欄位說明
error Object 錯誤資訊【詳見data欄位說明
Data參數描述
參數名 類型 說明
channelId Integer 頻道ID
userId String POLYV使用者ID,和保利威官網一致,取得路徑:官網->登入->直播(開發設定)
channelPasswd String 講師登入密碼,直播場景不是研討會時不為null,長度6-16位
seminarHostPassword String 研討會主持人密碼,僅直播場景是研討會時不為null,長度6-16位
seminarAttendeePassword String 研討會與會人密碼,僅直播場景是研討會時不為null,長度6-16位

Java請求範例

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

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

    /**
     * 创建研讨会频道
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void testBasicCreateV4() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/live/v4/channel/create";
        
        String name = "polyv研讨会";
        String newScene = "seminar";
        String recordMode = "auto";
        String seminarLiveType = "private";
        String seminarHostPassword = "hostpasswd";
        String seminarAttendeePassword = "attendeepasswd";
        
        //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("newScene", newScene);
        bodyMap.put("recordMode", recordMode);
        bodyMap.put("seminarLiveType", seminarLiveType);
        bodyMap.put("seminarHostPassword", seminarHostPassword);
        bodyMap.put("seminarAttendeePassword", seminarAttendeePassword);
        
        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("测试创建研讨会频道,返回值:{}", response);
        //do somethings
        
        }

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "788bc586bbe34965a15a284c511116df.66.16414529932010715",
  "data": {
    "channelId": 2771673,
    "userId": "1b448be323",
    "scene": null,
    "channelPasswd": null,
    "seminarHostPassword": "hostpasswd",
    "seminarAttendeePassword": "attendeepasswd"
  },
  "success": true
}

異常範例

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