Batch Create Channels

Legacy API Endpoint Batch Create Channels (Legacy)

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 will not affect already created channels. Changes to the information of existing channels are consistent with the old API.

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-batch

<a href="/req.html?api=http://api.polyv.net/live/v4/channel/create-batch"" 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 seminar, live streaming 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.

5. Create up to 30 channels at a time;

Request Parameter Description

Request Body Parameter Description

Example

http://api.polyv.net/live/v4/channel/create-batch?appId=frlr1zazn3&sign=FD701BFA3DCE2C7DCC362A904DBF48B0&timestamp=1636536555144

Request body JSON parameters:

[
    {
        "name": "研讨会",
        "newScene": "seminar",
        "pureRtcEnabled": "Y",
        "categoryId": 391352,
        "seminarHostPassword": "",
        "seminarAttendeePassword": ""
    },
    {
        "name": "我的频道-子账号",
        "newScene": "topclass",
        "template": "ppt",
        "pureRtcEnabled": "Y",
        "subAccount": "sdk-demo@polyv.net",
        "channelPasswd": "",
        "categoryId": 391352
    }
]

Response Parameter Description

data Parameter Description

element 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.

    private static final Logger log = LoggerFactory.getLogger(getClass());

    @Test
    public void testCreateBatchV4() 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-batch";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String body = "[{\"name\":\"研讨会\",\"newScene\":\"seminar\",\"pureRtcEnabled\":\"Y\",\"categoryId\":391352," +
        "\"seminarHostPassword\":\"aaaaaa\",\"seminarAttendeePassword\":\"bbbbbb\"},{\"name\":\"我的频道-子账号\"," +
        "\"newScene\":\"topclass\",\"template\":\"ppt\",\"pureRtcEnabled\":\"Y\",\"subAccount\":\"sdk-demo@polyv" +
        ".net\",\"channelPasswd\":\"123fds\",\"categoryId\":391352}]";
        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, please refer to the Global Error Description.

Successful Example

{
    "code": 200,
    "status": "success",
    "requestId": "62af5d29-a836-4bfb-8c4d-cbd6a84ea7e9",
    "data": [
        {
            "channelId": 2665205,
            "userId": "1b448be323",
            "scene": null,
            "channelPasswd": null,
            "seminarHostPassword": "aaaaaa",
            "seminarAttendeePassword": "bbbbbb"
        },
        {
            "channelId": 2665206,
            "userId": "1b448be323",
            "scene": null,
            "channelPasswd": "123fds",
            "seminarHostPassword": null,
            "seminarAttendeePassword": null
        }
    ],
    "success": true
}

Exception Example

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