创建单个频道(旧版)

接口描述

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

接口URL

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

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥】

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】

请求体参数描述

参数名必选类型说明

basicSetting

true

Object

基础设置【详见basicSetting字段说明】

authSettings

false

Array

观看条件设置【详见authSettings字段说明】

playbackSetting

false

Object

回放设置【详见playbackSetting字段说明】

teacher

false

Object

讲师设置【详见teacher字段说明】

roles

false

Array

角色设置【详见roles字段说明】

basicSetting参数描述

参数名必选类型说明

name

true

String

频道名称

channelPasswd

false

String

频道密码，长度不能超过16位，必须同时包含字母和数字

autoPlay

false

Integer

是否自动播放 0：不自动播放 1：自动播放，默认1

playerColor

false

String

播放器控制栏颜色，默认：#666666

scene

false

String

直播场景 alone：活动拍摄 ppt：三分屏 topclass：大班课 seminar：研讨会

categoryId

false

Integer

新建频道的所属分类，如果不提交，则为默认分类（分类ID可通过“查询直播分类”接口得到）

maxViewer

false

Integer

最大同时在线人数，0和-1表示不限制观看人数

startTime

false

Long

直播开始时间，13位毫秒级时间戳

desc

false

String

直播介绍的内容

publisher

false

String

主持人

linkMicLimit

false

Integer

连麦人数，最大16人（范围大于等于-1，小于等于全局设置的连麦人数），-1：使用全局设置的连麦人数

pureRtcEnabled

false

String

是否为无延时直播，默认为N Y：是 N：否

receive

false

String

是否为接收转播频道，不填或者填其他值为发起转播频道（注：需要开启频道转播功能该参数才生效） Y：表示是 N：表示否

receiveChannelIds

false

String

接收转播频道号，多个频道号用半角逗号，隔开，如果receive参数值为Y时，此参数无效（注：需要开启频道转播功能该参数才生效）

onlyOneLiveEnabled

false

String

频道是否只能直播一次，默认为N Y：是 N：否

coverImg

false

String

封面图片地址

splashEnabled

false

String

引导页开关，默认为N Y：是 N：否

splashImg

false

String

引导图地址

likes

false

Long

点赞数

pageView

false

Long

累积观看数

closeDanmu

false

String

是否关闭弹幕功能的开关， Y：表示关闭 N：表示不关闭

showDanmuInfoEnabled

false

String

是否显示弹幕信息开关， Y：表示显示 N：表示不显示

subAccount

false

String

子账号邮箱，填写时频道会创建在该子账号下（子账号不能被删除或者禁用），暂无法通过接口获取

authSettings参数描述

参数名必选类型说明

rank

true

Integer

主要观看条件为1，次要观看条件为2

enabled

true

String

是否开启条件观看 N：关闭 Y：开启

authType

false

String

pay：付费观看 code：验证码观看 info：登记观看 custom：自定义授权观看 external：外部授权观看 direct：独立授权观看

payAuthTips

false

String

当authType为pay时，设置参数，必填。欢迎语标题

price

false

Float

当authType为pay时，设置参数，必填。价格，单位为元

watchEndTime

false

String

当authType为pay时，设置参数，非必填。付费有效截止日期，格式：yyyy-MM-dd HH:mm

validTimePeriod

false

Integer

当authType为pay时，设置参数，非必填。付费有效时长，单位天。当watchEndTime和validTimePeriod都为空时，表示付费永久有效

authCode

false

String

当authType为code时，设置参数，必填。验证码

qcodeTips

false

String

当authType为code时，设置参数，非必填。提示文案

qcodeImg

false

String

当authType为code时，设置参数，非必填。公众号二维码地址

infoFields

false

Array

当authType为info时，设置参数，必填。登记观看信息，上限为5个【详见infoFields字段说明】

externalKey

false

String

当authType为external时，设置参数，必填。SecretKey

externalUri

false

String

当authType为external时，设置参数，必填。自定义url

externalRedirectUri

false

String

当authType为external时，设置参数，非必填。跳转地址

customKey

false

String

当authType为custom时，设置参数，必填。SecretKey

customUri

false

String

当authType为custom时，设置参数，必填。自定义url

directKey

false

String

当authType为direct时，设置参数，必填。独立授权SecretKey

InfoField参数描述

参数名必选类型说明

name

false

String

当authType为info时，设置参数，非必填。登记信息名，最多为8字符

type

false

String

当authType为info时，设置参数，必填。登记类型 name：姓名 text：文本 mobile：手机号码 number：数字 option：下拉选项

options

false

String

当authType为info时，设置参数，非必填。下拉选项时，下拉的选项值，以英文逗号分割。选项个数上限为8个；选项内容最多为8字符

placeholder

false

String

当authType为info时，设置参数，非必填。文本框输入提示，最多为8字符

sms

false

String

当authType为info时，设置参数，非必填。短信验证开关，Y：开启，N：关闭

playbackSetting参数描述

参数名必选类型说明

globalSettingEnabled

false

String

是否应用通用设置 Y：是 N：否

playbackEnabled

false

String

回放开关 Y：开启 N：关闭

type

false

String

回放方式 single：单个回放 list：列表回放

origin

false

String

回放来源 record：暂存 playback：回放列表 vod：点播列表

videoId

false

String

单个回放的视频id

teacher参数描述

参数名必选类型说明

nickname

false

String

讲师昵称，长度1~8位，默认为讲师

actor

false

String

讲师头衔，长度1~8位，默认为讲师

passwd

false

String

讲师密码（和basicSetting.channelPasswd说明一致，此处可不设置）

avatar

false

String

头像图片地址

roles参数描述

参数名必选类型说明

nickname

false

String

角色昵称，长度1~8位

actor

false

String

角色头衔，长度1~8位

passwd

false

String

角色密码

avatar

false

String

头像图片地址

role

false

String

角色类型 Assistant-助教 Guest-嘉宾

示例

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

请求体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"
        }
    ]
}

响应参数描述

参数名类型说明

code

Integer

响应状态码，200为成功返回，非200为失败【详见全局错误说明】

status

String

响应状态文本信息

message

String

响应描述信息，当code为400或者500的时候，辅助描述错误原因

data

Object

成功响应时返回频道详细信息【详见data字段说明】

Data参数描述

参数名类型说明

channelId

String

直播频道号

userId

String

POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）

name

String

直播频道名称

publisher

String

主持人

description

String

直播频道描述

url

String

直播推流地址

stream

String

直播流名称

logoImage

String

播放器logo

logoOpacity

Float

Logo不透明度 1：表示完全不透明 0：表示完全透明

logoPosition

String

logo位置 tr1：左上 tr：右上 b1：左下 br：右下

logoHref

String

Logo的跳转链接

coverImage

String

播放前显示的封面图

coverHref

String

封面图的跳转链接

waitImage

String

等待推流时的显示图片

waitHref

String

等待推流时显示图片的跳转链接

cutoffImage

String

切断流时的显示图片

cutoffHref

String

切断流时显示图片的跳转链接

advertType

String

片头广告 NONE：无广告 IMAGE：图片 FLV：视频

advertDuration

Integer

广告时长（秒）

advertWidth

Integer

广告区域宽度（像素）

advertHeight

Integer

广告区域高度（像素）

advertImage

String

图片广告

advertHref

String

广告的跳转链接

advertFlvVid

String

视频广告ID

advertFlvUrl

String

视频广告链接

playerColor

String

播放器控制栏颜色，例如 #666666

autoPlay

Boolean

是否自动播放

warmUpFlv

String

暖场视频链接

passwdRestrict

Boolean

观看密码限制，需要输入观看密码才能播放流

passwdEncrypted

String

观看密码加密后的密文

isOnlyAudio

String

Y：音频模式 N：普通模式

isLowLatency

String

低延迟

channelLogoImage

String

频道图标

scene

String

直播场景 alone：活动拍摄 ppt：三分屏 topclass：大班课 seminar：研讨会

channelViewerPasswd

String

参与者密码

channelPasswd

String

频道密码

linkMicLimit

Integer

连麦人数 -1：使用账号连麦分数 0-16：代表连麦人数

streamType

String

直播方式 client：客户端推流 pull：拉流 thirdpull：第三方拉流 disk：伪直播 audio：音频直播

pureRtcEnabled

String

是否为无延时直播，默认为N Y：是 N：否

type

String

频道类型 发起转播：transmit 接收转播：receive 普通频道：normal

cnAndEnLiveEnabled

String

中英文直播间开关 Y：开启 N：关闭

pushEnUrl

String

英文推流地址

currentTimeMillis

Long

当前时间戳（毫秒）

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

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
Previous创建重制课件任务Next批量创建接收转播的频道

Last updated