保利威文档中心

帮助中心

创建研讨会频道(旧版后台)

更新时间:2024-12-16 19:20:19

接口描述

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

接口URL

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

在线API调用

请求方式

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字段说明
basicSetting参数描述
参数名 必选 类型 说明
name true String 频道名称
channelPasswd true String 频道密码,(可以通过频道号+频道密码登录该频道)长度不能超过16位,必须同时包含字母和数字
scene false String 直播场景
seminar:研讨会
categoryId false Integer 新建频道的所属分类,如果不提交,则为默认分类(分类ID可通过“查询直播分类”接口得到)
coverImg false String 封面图片地址
likes false Long 点赞数
pageView false Long 累积观看数
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

示例

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

请求体json参数:

{
    "basicSetting": {
        "name": "创建研讨会频道",
        "channelPasswd": "polyv123"
    },
    "authSettings": [
        {
            "watchEndTime": 1616753886000,
            "rank": 1,
            "enabled": "Y",
            "authType": "external",
            "externalKey": "L0EjokKI4O",
            "externalUri": "http://demo.ipolyv.cn/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 直播频道描述
scene String 直播场景
seminar:研讨会
channelPasswd 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\":\"polyv123\"}," +
    "\"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": "创建研讨会频道",
        "channelPasswd": "polyv123",
        "scene": "seminar",
        "currentTimeMillis": 1636706867876
    }
}

异常示例

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