Create a Single Channel (Legacy)

Interface Description

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

Interface URL

http://api.polyv.net/live/v3/channel/basic/create

Request Method

POST

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Request Body Parameter Description

basicSetting Parameter Description

authSettings Parameter Description

InfoField Parameter Description

playbackSetting Parameter Description

teacher Parameter Description

roles Parameter Description

Example

http://api.polyv.net/live/v3/channel/basic/create?appId=frlr1zazn3&sign=A4433D6B4C9E5F34415EBACA2F206DDE&timestamp=1636706861620

Request body JSON parameters:

{
    "basicSetting": {
        "name": "测试子账号创建频道",
        "channelPasswd": "j12dno3a12",
        "maxViewer": 20,
        "subAccount": "test-dev@qq.com",
        "categoryId": 391352
    },
    "authSettings": [
        {
            "watchEndTime": 1616753886000,
            "rank": 1,
            "enabled": "Y",
            "authType": "external",
            "externalKey": "L0EjokKI4O",
            "externalUri": "http://demo.ipolyv.cn/chenwb/live-validate.php"
        }
    ]
}

Response Parameter Description

Data Parameter Description

Java Request Example

For quick integration of 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. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建单个频道
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testBasicCreate() 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/v3/channel/basic/create";
    
    //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\":{\"name\":\"测试子账号创建频道\",\"channelPasswd\":\"j12dno3a12\",\"maxViewer\":20," +
    "\"subAccount\":\"test-dev@qq.com\",\"categoryId\":391352}," +
    "\"authSettings\":[{\"watchEndTime\":1616753886000,\"rank\":1,\"enabled\":\"Y\"," +
    "\"authType\":\"external\",\"externalKey\":\"L0EjokKI4O\",\"externalUri\":\"http://demo.polyv" +
    ".net/chenwb/live-validate.php\"}]}";
    String response = HttpUtil.postJsonBody(url, json, null);
    log.info("测试创建单个频道，返回值：{}", response);
    //do somethings
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 2671450,
        "userId": "1b448be323",
        "name": "测试子账号创建频道",
        "publisher": null,
        "description": "",
        "url": "rtmp://push-d1.videocc.net/recordf/1b448be3231636706865463d4d0?auth_key=1636708667-0-0-a1f63391368503d2c72caa4021588a99",
        "stream": "1b448be3231636706865463d4d0",
        "logoImage": "https://liveimages.videocc.net/uploaded/images/2021/04/fy3ce1e8uh.png",
        "logoOpacity": 0.37,
        "logoPosition": "tr",
        "logoHref": "",
        "coverImage": "",
        "coverHref": "",
        "waitImage": "",
        "waitHref": "",
        "cutoffImage": "",
        "cutoffHref": "",
        "advertType": "NONE",
        "advertDuration": 0,
        "advertWidth": 0,
        "advertHeight": 0,
        "advertImage": "",
        "advertHref": "",
        "advertFlvVid": "",
        "advertFlvUrl": "",
        "playerColor": "#666666",
        "autoPlay": false,
        "warmUpFlv": "",
        "passwdRestrict": false,
        "passwdEncrypted": "",
        "isOnlyAudio": "N",
        "isLowLatency": "N",
        "m3u8Url": "http://pull-d1.videocc.net/recordf/1b448be3231636706865463d4d0.m3u8?auth_key=1636706867-0-0-020d65f5b0ead855eda5220abeb60278",
        "m3u8Url1": "",
        "m3u8Url2": "",
        "m3u8Url3": "",
        "channelLogoImage": null,
        "scene": "alone",
        "channelViewerPasswd": null,
        "channelPasswd": "j12dno3a12",
        "linkMicLimit": 16,
        "streamType": "client",
        "pureRtcEnabled": "N",
        "type": "normal",
        "cnAndEnLiveEnabled": null,
        "pushEnUrl": null,
        "closeDanmu": "N",
        "currentTimeMillis": 1636706867876
    }
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}