描述
获取直播信息,支持获取子账号直播信息
接口地址
http://e.vhall.com/api/vhallapi/v2/webinar/fetch
请求参数
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
webinar_id | int | 是 | 9位数字,直播ID |
fields | string | 是 | 直播基础信息数据,字段之间用英文逗号,分割 |
接口中必须包含公共请求参数。关于公共请求参数详细内容,请参考 公共请求参数。
fields 参数详情
字段名 | 说明 |
---|---|
id | 直播ID |
alias_name | 别名,唯一,程序判断是否重复 |
user_id | 用户ID |
subject | 直播标题 |
introduction | 直播简介 |
img_url | 封面图片 |
category | 类别 |
is_open | 是否公开,默认0为公开,1为不公开 |
layout | 布局,三分屏等,1为单视频,2为“语音+文档”,3为“视频+文档” |
verify | 验证类别,0 无验证,1 密码,2 白名单,3 付费活动, 4 F码 |
password | 直播密码设置 |
type | 1为直播,2为预约,3为结束,4为点播,5 结束且有自动回放 |
topics | 此直播的话题标签, 格式为 "标签1,标签2,标签3" |
is_iframe | 是否允许嵌入,1为允许嵌入 |
is_chat | 是否允许聊天,默认0为允许,1为不允许 |
buffer | 观看方延迟 |
t_start | 开始时间 |
end_time | 直播结束时间默认为 0000-00-00 00:00:00 |
host | 拥有者昵称 |
live_start_time | 最后一次开始直播时间 |
is_new_version | 0为旧版布局,1是新版布局 |
is_interact | 1是互动直播,0是否 |
player | 播放器类型1是flash,2是h5 |
exist_3rd_auth | 是否开启了第三方K值验证,0不开启,1为开启 |
auth_url | 第三方K值验证接口URL |
show_type | 展示方式 0 竖屏 1横屏 |
响应参数
返回形如''{"code":200,"msg":"success","data": {"subject":"我是测试"}''的json。data部分数据如下:
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
{"subject":"我的微吼"} | json | 否 | 返回相应字段值(JSON格式) |
响应示例
{
"code": 200,
"msg": "success",
"data": {"subject":"我的微吼"}
}
错误码
code | 含义 |
---|---|
10017 | 直播id为空 |
10010 | 直播不存在 |
10011 | 不是自己的直播 |