保利威文档中心

帮助中心

创建单个频道(旧版)

更新时间:2022-12-20 17:27:05

接口描述

1、创建频道并进行相关设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channels/

请求方式

POST

接口约束

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

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
timestamp true Long 当前13位毫秒级时间戳,3分钟内有效
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
userId true String POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
name true String 频道名称,最大长度60
channelPasswd true String 频道密码,长度不能超过16位
scene false String 直播场景,默认alone
alone:活动拍摄
ppt:三分屏
topclass:大班课
seminar:研讨会
pureRtcEnabled false String 是否为无延时直播,默认为N
Y:是
N:否
cnAndEnLiveEnabled false String 中英文直播间开关,默认为N
Y:开启
N:关闭
englishSettingEnabled false String 英文直播间开关,默认为N
Y:开启
N:关闭
publisherEnglishName false String 英文主持人名称
channelEnglishName false String 英文频道名称
categoryId false Integer 新建频道的所属分类,如果不提交,则为默认分类(分类ID可通过“查询直播分类”接口得到)
maxViewer false Integer 最大同时在线人数,0和-1表示不限制观看人数
linkMicLimit false Integer 连麦人数,最大16人(范围大于等于-1,小于等于全局设置的连麦人数),-1:使用全局设置的连麦人数
playerColor false String 播放器控制栏颜色,默认:#666666
autoPlay false Integer 是否自动播放
0:不自动播放
1:自动播放,默认1
receive false String 是否为接收转播频道,不填或者填其他值为发起转播频道(注:需要开启频道转播功能该参数才生效)
Y:表示是
N:表示否
receiveChannelIds false String 接收转播频道号,多个频道号用半角逗号,隔开,如果receive参数值为Y时,此参数无效(注:需要开启频道转播功能该参数才生效)
channelObject false String 频道属性
doubleEnabled false String 双师频道属性,N不开启(默认为N)Y为双师频道
bookingEnabled false String 预约的功能开关,默认为Y
Y:开启
N:关闭
streamType false String 直播方式
client:客户端推流
pull:拉流
thirdpull:第三方拉流
disk:伪直播
audio:音频直播
aloneWatchLayout false String 普通直播观看页布局配置(普通:normal,竖屏:portrait),默认普通直播

示例

http://api.polyv.net/live/v2/channels?appId=frlr1zazn3&timestamp=1671527624000&sign=AD7FC9F7F3E55B1145E354FB291590E3&name=%E5%B0%8F%E8%AF%BE%E5%A0%82&userId=1b448be323&channelPasswd=32L8PQC08sg

响应参数描述

参数名 类型 说明
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 直播流的URL
stream String 直播流名
logoImage String LOGO的图片地址
logoOpacity Double LOGO的透明度
logoPosition String LOGO在播放器上的位置
logoHref String LOGO的外链地址
coverImage String 封面图片地址
coverHref String 封面图片的外链地址
waitImage String 等待直播流的图片
waitHref String 等待直播流图片的外部链接
cutoffImage String 断流图片的地址
cutoffHref String 断流图片的外链地址
advertType String 广告的类型,无广告、图片广告、FLV广告
advertDuration Integer 广告时长,单位:秒
advertWidth Integer 广告的宽,单位:像素
advertHeight Integer 广告的高,单位:像素
advertImage String 图片广告的地址
advertHref String 广告的外链地址
advertFlvVid String FLV广告在PolyV系统中的videoId
advertFlvUrl String FLV广告的URL
playerColor String 播放器控制栏的颜色
autoPlay Boolean 是否自动播放
warmUpFlv String 暖场视频
passwdRestrict Boolean 是否设置了密码保护
playCodeRestrict Boolean 是否设置了密码保护,等同字段passwdRestrict
passwdEncrypted String MD5加密后的播放密码
playCodeEncrypted String MD5加密后的播放密码,等同字段passwdEncrypted
isOnlyAudio String 是否为音频直播
isLowLatency String 是否为低延迟直播
m3u8Url String M3U8的URL地址
m3u8Url1 String 标清M3U8地址
m3u8Url2 String 高清M3U8地址
m3u8Url3 String 超清M3U8地址
channelLogoImage String 频道的logo图片
scene String 频道的直播场景
channelViewerPasswd String 参与者密码
channelPasswd String 频道密码
linkMicLimit Integer 连麦人数
streamType String 直播方式
pureRtcEnabled String 是否是纯rtc拉流
type String 频道类型,发起转播、接收转播
cnAndEnLiveEnabled String 中英文直播间开关
pushEnUrl String 英文推流地址
closeDanmu String 弹幕开关

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 11667086,
        "userId": "1b448be323",
        "name": "polyv小课堂",
        "publisher": "主持人",
        "description": "",
        "url": "rtmp://push-d1.videocc.net/recordf/1b448be32316715274020016771?auth_key=1671529203-0-0-f6198f001ccf7fca946c90801ef9c504",
        "stream": "1b448be32316715274020016771",
        "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,
        "playCodeRestrict": false,
        "passwdEncrypted": "",
        "playCodeEncrypted": null,
        "isOnlyAudio": "N",
        "isLowLatency": "N",
        "m3u8Url": "http://pull-d1.videocc.net/recordf/1b448be32316715274020016771.m3u8?auth_key=1671527403-0-0-de8272610bc40f7102dcb880cfde138d",
        "m3u8Url1": "",
        "m3u8Url2": "",
        "m3u8Url3": "",
        "channelLogoImage": "https://liveimages.videocc.net/uploaded/images/2022/11/gffeocwo9n.png",
        "scene": "alone",
        "channelViewerPasswd": null,
        "channelPasswd": "QIbGmAmhMJ1dq",
        "loginCode": null,
        "linkMicLimit": 16,
        "streamType": "client",
        "pureRtcEnabled": "N",
        "type": "normal",
        "cnAndEnLiveEnabled": "N",
        "pushEnUrl": null,
        "closeDanmu": "N",
        "currentTimeMillis": 1671527405150
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询