用户工具

站点工具


open:vhall_api_test

* vhall_api_for_测试_2.3.7

接口 更新内容
1 webinar/fetch 获取活动信息,请求参数type,增加4,点播活动(回放发布产生)
2 webinar/state 获取活动状态,响应参数返回码,增加4,点播活动(回放发布产生)
3 webinar/list 获取活动列表,请求参数status,增加4,点播活动(回放发布产生,不可与其他状态组合查询)

webinar/fetch 获取活动信息

获取活动信息,支持获取子账号活动信息

URL 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码, 5 报名表单
password 活动密码设置
type 1为直播,2为预约,3为结束,4为点播
is_single_video 是否单视频,1为是
is_iframe 是否允许切入,1为允许切入
auto_record 是否自动回放,1为是,2为否
is_chat 是否允许聊天,默认0为允许,1为不允许
buffer 观看方延迟
t_start 开始时间
end_time 活动结束时间默认为0,代表永久,可以手动设置结束时间或彻底结束
host 拥有者昵称
live_start_time 最后一次开始直播时间

响应参数

返回形如{“code”:200,”msg”:“success”,”data”: {“subject”:“我是测试”}的json。data部分数据如下:

参数名 类型 必选 说明
{“subject”:“我的微吼”} json 返回相应字段值(JSON格式)

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {"subject":"我的微吼"}
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动

webinar/state 获取活动状态

获取活动状态

URL http://e.vhall.com/api/vhallapi/v2/webinar/state 

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 9位数字

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:2的json。data值的数据类型如下:

类型 说明
int 当前活动的状态码

状态码

状态码 类型 必选 释义,说明
1 int 直播进行中, 参加者可以进入观看直播
2 int 预约中 , 活动预约中,尚未开始
3 int 活动已结束但无默认回放
4 int 点播活动,不同于活动结束生成的回放,可由回放发布产生

响应示例

{
    "code": 200,
    "msg": "success",
    "data": 1
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动

webinar/list 获取活动列表

获取活动列表

URL http://e.vhall.com/api/vhallapi/v2/webinar/list 

请求参数

参数名 类型 必选 说明
user_id int 子账号对应的微吼用户user_id(该参数仅在需要获取单个子账号下的活动时传入,且type需传1,传2、3无效)
type int 1为所请求账号下的全部活动,2为所请求账号的子账号下的全部活动,3为所请求账号及其子账号下的全部活动
pos int 数字,设置从第几条数据开始获取,如果是第一条数据(pos=0)
limit int 数字,每次返回条数
status int 1:直播进行中,2:预约中,3:结束,4:点播。 不传递此参数则为所有活动,(如需组合查询,可将该值写成json字符串的形式。如status为[1,2]代表同时获取活动状态1和活动状态2,但是查询点播不可以使用数组形式

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{'webinar_id':'1234','subject':'活动名称'}的json。data部分数据如下:

参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式),包含创建时间以及创建者的微吼用户id

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'webinar_id': '654067993',
        'user_id':12345678',
        'subject' : 'test_webinar_name',
        'start_time': '2015-11-20 15:29:00',
        'status': 1, // 1:直播进行中,2:预约中,3:结束
        'desc': 'test_webinar_introduction',
        'thumb': ''
    }
}

错误码

code 含义
10019 没有活动

webinar/custom-broadcast 发送自定义广播消息

发送自定义广播消息

URL http://e.vhall.com/api/vhallapi/v2/webinar/custom-broadcast

请求参数

参数名 类型 必选 说明
webinar_id int 活动id
msg varchar json编码后的数组字符串,长度不能超过200, 例:{“text”:“this is msg”}

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:2的json。data值的数据类型如下:

类型 说明
int 当前活动的状态码

响应示例

{
    "code": "200",
    "msg": "成功",
    "data": []
}

错误码

code 含义
12400 自定义消息不能为空
12401 用户身份认证错误!
12402 用户发送消息频次超过限制!
12403 发送消息频次超过限制!
12404 自定义广播消息内容长度超过限制!
12405 内部接口异常,请联系管理员!
12406 消息长度的json字符串不能超过200!
12407 消息数据必须为json编码的数组
open/vhall_api_test.txt · 最后更改: 2017/10/16 10:26 由 zuan.yu