创建直播
描述
创建直播
接口地址
http://e.vhall.com/api/vhallapi/v2/webinar/create
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| player | int | 否 | 创建直播时的播放器类型。1代表flash播放器，2代表H5播放器，默认为1。此参数创建后不可更改，当参数为2时，is_new_version参数必传且为1。使用sdk的用户，请升级sdk至最新版本。 |
| subject | string | 是 | <30个字符,活动主题 |
| start_time | int | 是 | Linux时间戳,直播开始时间 |
| user_id | int | 否 | 通过第三方创建用户接口获取的微吼用户ID，子账号创建活动时此参数必填，管理员账号创建直播时忽略此参数 |
| use_global_k | int | 否 | 默认为0不开启，1为开启,是否针对此活动开启全局K值配置 |
| exist_3rd_auth | int | 否 | 默认为0不开启，1为开启,是否开启第三方K值验证查看说明 |
| auth_url | string | 否 | http://domain,<256个字符,第三方K值验证接口URL(exist_3rd_auth为1必填) |
| failure_url | string | 否 | http://domain,<256个字符,第三方K值验证失败跳转URL(可选) |
| introduction | string | 否 | <1024个字符,活动描述 |
| topics | string | 否 | 直播话题标签字段,以","(半角符号) 分割可以多个,标签最多为6个,单个标签不超过8个字 格式例: "商务,教育,视频教育" |
| layout | int | 否 | 1为单视频,2为单文档,3为文档+视频,观看布局.如果is_new_version为1且活动为互动，该参数只能为3， 如果is_new_version为1且活动不为互动，该参数可以选2或3 |
| is_new_version | int | 否 | 0为旧版布局,1为新版布局，默认旧版布局。当player参数为2时，is_new_version参数必传且为1。 |
| type | int | 否 | 0为公开,1为非公开,个人公开/非公开活动 |
| is_chat | int | 否 | 0为是,1为否(默认为是),是否开启聊天 |
| host | string | 否 | <50个字符,可为空,主持人的姓名 |
| buffer | int | 否 | >0的数字,可为空,直播延时，单位为秒，默认为3 |
| is_allow_extension | int | 否 | 默认为1表示开启并发扩展包，传其他参数表示不开启，流量套餐或没有并发扩展包时忽略此参数 |
| is_interact | int | 否 | 1是互动直播，0是否 |
| webinar_show_type | int | 否 | 展示方式 0 竖屏 1横屏，默认为1。竖屏推流直播请使用微吼直播APP推流，网页直播默认横屏推流 |
接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。
响应参数
返回形如''{"code":200,"msg":"success","data":10}''的json。data值的数据类型如下：
| 类型 | 说明 |
|---|---|
| int | 创建成功，返回9位数直播ID |
响应示例
{
"code": "200",
"msg": "创建成功",
"data": 654067993
}
错误码
| code | 含义 |
|---|---|
| 10014 | 直播标题不能为空 |
| 10059 | 直播标题不能超过30个字符 |
| 10013 | 直播开始时间不能为空 |
| 10013 | 直播结束时间小于开始时间 |
| 10016 | k值验证的验证地址不能为空 |
| 10026 | 布局设置参数错误 |
| 10053 | 回放设置参数错误 |
| 10054 | 聊天设置参数错误 |
| 10056 | buffer设置不能小于0 |
| 10003 | 没有可用的扩展包 |
| 10103 | 第三方用户对象不存在 |
| 10104 | 子账号信息不存在 |
| 12100 | 单个话题标签不能超过8个字 |
| 12101 | 最多只可添加6个话题标签 |
| 13202 | 版本参数错误 |
| 13203 | 新版布局不能为单视频 |
