建立並初始化頻道

舊版接口地址建立單個頻道(舊版)

介面描述

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援 HTTP 與 HTTPS，建議使用 HTTPS 以確保介面安全，介面呼叫有頻率限制，詳細請參閱

2、直播場景為雙師課、研討會時，不支援轉播類型設定；直播延遲為無延遲時，不支援轉播類型設定；

3、直播場景為研討會時，不支援直播延遲、轉播、連麥人數設定；

4、研討會場景下主持人密碼與參與者密碼不能相同；

請求參數說明

請求體參數說明

basicSetting 參數說明

masterAuthSetting 參數說明

playbackSetting 參數說明

roles 參數說明

範例

http://api.polyv.net/live/v4/channel/create-init?appId=frlr1zazn3&sign=4424EF1F6C767FC0E2FB4A912E566879&timestamp=1653879013148

請求體 JSON 參數：

{
    "basicSetting": {
        "template": "ppt",
        "newScene": "topclass",
        "type": "normal",
        "cnAndEnLiveEnabled": "N",
        "linkMicLimit": "5",
        "doubleTeacherType": "normal",
        "name": "polyv公开课",
        "startTime": "1747718040000",
        "pureRtcEnabled": "Y",
        "description": "通过游戏的带入课程<br/>让课堂生动有趣",
        "channelPasswd": "1a2b3c4d5e",
        "logoImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
        "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg"
    },
    "masterAuthSetting": {
        "enabled": "Y",
        "authType": "code",
        "authCode": "123456"
    },
    "playbackSetting":{
        "playbackEnabled":"Y",
        "sectionEnabled":"Y",
        "type":"list",
        "origin":"vod"
    },
    "roles": [
        {
            "role": "Teacher"
        },
        {
            "role": "Assistant",
            "actor": "助教",
            "nickName": "勋助教"
        },
        {
            "role": "Guest",
            "passwd": "aSzqyd13qz",
            "actor": "嘉宾",
            "avatar": "https://s1.videocc.net/default-img/avatar/guest.png",
            "nickName": "王嘉宾"
        }
    ]
}

回應參數說明

Error 參數說明

data 欄位說明

Java 請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建单个频道
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCreateInit() 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/create-init";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    String json = "{\"basicSetting\":{\"template\":\"ppt\",\"newScene\":\"topclass\",\"type\":\"normal\"," +
    "\"cnAndEnLiveEnabled\":\"N\",\"linkMicLimit\":\"5\",\"doubleTeacherType\":\"normal\"," +
    "\"name\":\"polyv公开课\",\"startTime\":\"1747718040000\",\"pureRtcEnabled\":\"Y\"," +
    "\"description\":\"通过游戏的带入课程，让课堂生动有趣\",\"channelPasswd\":\"1a2b3c4d5e\"," +
    "\"logoImg\":\"https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg\"," +
    "\"splashImg\":\"https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg\"}," +
    "\"masterAuthSetting\":{\"enabled\":\"Y\",\"authType\":\"code\",\"authCode\":\"123456\"}," +
    "\"roles\":[{\"role\":\"Teacher\"},{\"role\":\"Assistant\",\"actor\":\"助教\",\"nickName\":\"勋助教\"}," +
    "{\"role\":\"Guest\",\"passwd\":\"aSzqyd13qz\",\"actor\":\"嘉宾\",\"avatar\":\"https://s1.videocc" +
    ".net/default-img/avatar/guest.png\",\"nickName\":\"王嘉宾\"}]}";
    
    String response = HttpUtil.postJsonBody(url, json, null);
    
    log.info("测试创建单个频道成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例（測試範例頻道號已隱藏）

{
    "code": 200,
    "status": "success",
    "requestId": "14138a5004b1412fbe109f854fec0b52.59.16538790171742883",
    "data": {
        "channelId": ******,
        "name": "polyv公开课",
        "userId": "1b448be323",
        "channelPasswd": "t2IIefL6toqoBAA",
        "seminarHostPassword": null,
        "seminarAttendeePassword": null,
        "publisher": null,
        "description": "通过游戏的带入课程，让课堂生动有趣",
        "newScene": "topclass",
        "template": "ppt",
        "linkMicLimit": 5,
        "pureRtcEnabled": "Y",
        "type": "normal",
        "currentTimeMillis": 1653879017848
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}