Create Channel

Old API endpoint Create Single Channel (Old Version)

Notes on Upgrading from Legacy API to New API

1. When creating a channel using the old API, you can directly set the channel's basic information, viewing conditions, replay settings, instructor settings, and role settings.
2. When creating a channel using the new API, you can only set the channel's basic information. Viewing conditions, replay settings, instructor settings, and role settings are derived from the default template settings. The default template must be configured before creating a channel.
3. Modifications to the default template do not affect already created channels. Changes to existing channel information are consistent with the old API.
4. The live streaming scenario (scene) in the old API corresponds to the live streaming template (template) in this API. Since the old API does not have the concept of a scenario (newScene field), after upgrading from the old to the new version, channels created using the old API will display "undefined" for the scenario in the new live streaming backend, which has no impact on the data.

Interface Description

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

Interface URL

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

<a href="/req.html?api=http://api.polyv.net/live/v4/channel/create"" target="_blank">Online API Call

Request Method

POST

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. For details, please refer to

2. When the live streaming scenario is a dual-teacher class or seminar, the relay type setting is not supported; when the live streaming delay is set to no delay, the relay type setting is not supported.

3. When the live streaming scenario is a webinar, live delay, rebroadcasting, and the number of co-hosts settings are not supported.

4. In the seminar scenario, the host password and participant password must not be the same.

Request Parameter Description

Request Body Parameter Description

Example

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

Request body JSON parameters:

{
    "template": "ppt",
    "doubleTeacherType": "normal",
    "name": "polyv小课堂",
    "startTime": "1779254040000",
    "newScene": "topclass",
    "newSessionEnabled": "Y",
    "type": "normal",
    "pureRtcEnabled": "Y",
    "linkMicLimit": "6",
    "labelData":[]
}

Response Parameter Description

Data Parameter Description

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases HttpUtil.java and LiveSignUtil.java are both included in the downloaded file.

It is strongly recommended that you use the Live Java SDK to complete the API functionality integration. The Live Java SDK provides a unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

    /**
     * 创建单个频道
     * @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 = "topclass";
        String template = "ppt";
        String pureRtcEnabled = "Y";
        String type = "normal";
        String doubleTeacherType = "normal";
        String cnAndEnLiveEnabled = "N";
        String linkMicLimit = "5";
        String categoryId = "";
        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("newScene", newScene);
        bodyMap.put("template", template);
        bodyMap.put("pureRtcEnabled", pureRtcEnabled);
        bodyMap.put("type", type);
        bodyMap.put("doubleTeacherType", doubleTeacherType);
        bodyMap.put("cnAndEnLiveEnabled", cnAndEnLiveEnabled);
        bodyMap.put("linkMicLimit", linkMicLimit);
//      bodyMap.put("categoryId", categoryId);
        bodyMap.put("channelPasswd", "Y2KRyUauSITWv");
//      bodyMap.put("seminarHostPassword", "lLnAtoeNfAID3");
//      bodyMap.put("seminarAttendeePassword", "cpoonjki9CRBh");
        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("测试创建单个频道，返回值：{}", response);
        //do somethings
        
        }

Response Example

For a detailed explanation of system-wide errors, see Global Error Description.

Successful Example

{
    "code": 200,
    "status": "success",
    "requestId": "847f0716fa76461baf8979aaa4415dc3.67.16342672396023837",
    "data": {
        "channelId": 2614804,
        "userId": "1b448be323",
        "scene": null,
        "channelPasswd": "jvO3RbFTKE61A",
        "seminarHostPassword": null,
        "seminarAttendeePassword": null
    },
    "success": true
}

Error Example

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