创建并初始化频道

旧版接口地址创建单个频道(旧版)

接口描述

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
}