Create and Initialize a Channel

Old API Endpoint Create Single Channel (Old Version)

API Description

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

Interface URL

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

<a href="/req.html?api=http://api.polyv.net/live/v4/channel/create-init"" 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 latency is set to zero latency, 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

basicSetting Parameter Description

masterAuthSetting Parameter Description

playbackSetting Parameter Description

roles Parameter Description

Example

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

Request body JSON parameters:

{
    "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": "王嘉宾"
        }
    ]
}

Response Parameter Description

Error Parameter Description

Description of the data field

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 include HttpUtil.java and LiveSignUtil.java, both of which are contained 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 pooling.

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
    
}

Response Example

For a detailed explanation of system-wide errors, please refer to the Global Error Description.

Successful Example (Test example channel number has been hidden)

{
    "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
}

Error Example

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