用户工具

站点工具


open:todo_活动管理

webinar/create 创建活动

请求参数

参数名 类型 必选 说明
subject string <50个字符,活动主题
start_time int Linux时间戳,活动开始时间
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个字符,活动描述
layout int 1为单视频,2为单文档,3为文档+视频,观看布局
type int 0为公开,1为非公开,个人公开/非公开活动
auto_record int 0为否,1为是(默认为否),是否自动回放
is_chat int 0为是,1为否(默认为是),是否开启聊天
host string <50个字符,可为空,主持人姓名
buffer int >0的数字,可为空,直播延时

响应参数

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

参数名 类型 必选 说明
webinar_id int 创建成功,返回9位数活动ID

响应示例

{
    "code": "200",
    "msg": "创建成功",
    "data": 654067993
}

错误码

code 含义
10014 活动标题过长
10014 活动标题过长
10014 主持人姓名过长
10013 活动开始时间不能为空
10013 活动结束时间小于开始时间
10016 k值验证的验证地址不能为空
10026 布局设置参数错误
10026 回放设置参数错误
10026 聊天设置参数错误
10026 buffer设置不能小于0

webinar/start 主持人开始活动

请求参数

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

响应参数

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

参数名 类型 必选 说明
http://e.vhall.com/domain string 主持人发起活动链接URL,访问此url跳转到组织者界面页面,使用Iframe嵌入或者直接跳转

响应示例

{
    "code": 200,
    "msg": "success",
    "data": 'http://e.vhall.com/webinar/host/654067993'
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10050 服务器错误

webinar/fetch 获取活动信息

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字, 活动ID
fields string 获取数据参见更新活动信息的字段名字需获取的活动基础信息数据,段之间用英文 , 分割)

响应参数

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

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

响应示例

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

错误码

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

获取活动状态(webinar/state)

webinar/state 获取活动状态

请求参数

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

响应参数

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

参数名 类型 必选 说明
状态码 int当前活动状态

状态码

状态码 类型 必选 释义,说明
1 int 直播进行中, 参加者可以进入观看直播
2 int 预约中 , 活动预约中,尚未开始
3 int 结束 , 活动已结束
4 int 录播已上线, 参加者可以观看录播回放

响应示例

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

错误码

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

webinar/list 获取活动列表

请求参数

参数名 类型 必选 说明
type int 0为网站公开活动,1为个人所有活动,0/1
pos int 数字,分页开始
limit int 数字,返回条数
status int 1直播进行中2预约中3结束为空则为所有活动,(如需组合查询,可将该值写成json字符串的形式。如status为[1,2]代表同时获取活动状态,活动状态

响应参数

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

参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式)

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'webinar_id': '654067993',
        'subject' : 'test_webinar_name',
        'start_time': '2015-11-20 15:29:00',
        'status': 0,
        'desc': 'test_webinar_introduction',
        'thumb': ''
    }
}

错误码

code 含义
10019 没有活动

webinar/update 更新活动信息

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID,9位数字
subject[必填] int 活动主题,<50个字符
start_time[必填] int 活动开始时间,Linux时间戳
exist_3rd_auth int 是否开启第三方K值验证查看说明,默认为0不开启,1为开启
auth_url int
introduction int 活动描述,<1024个字符
layout int 观看布局,1为单视频,2为单文档,3为文档+视频
is_open int 活动公开状态,0为公开,1为非公开
auto_record int 是否自动回放,0为否,1为是
is_chat int 是否开启聊天,0为是,1为否
host int 主持人姓名,<50个字符,可为空
buffer int 直播延时,>0的数字,可为空

响应参数

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

参数名 类型 必选 说明
webinar_id int 更新活动成功,返回9位数活动ID

响应示例

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

错误码

code 含义
10010 活动不存在
10014 活动标题过长
10014 主持人姓名过长
10013 活动开始时间不能为空
10013 活动结束时间小于开始时间
10011 不是自己的活动
10016 k值验证的验证地址不能为空
10500 '更新失败

webinar/stop 结束活动

请求参数

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

响应参数

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

响应示例

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

错误码

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

resource/action 删除活动

请求参数

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

响应参数

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

参数名 类型 必选 说明
webinar_id int 删除成功,返回9位数活动ID

响应示例

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

错误码

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

guest/url 嘉宾页面入口

功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明,功能说明。

URL http://e.vhall.com/api/vhallapi/v2/guest/url

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
email[必填] string <60个字符,邮箱格式,邮箱
name[必填] string <30个字符,昵称

响应参数

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

参数名 类型 必选 说明
http://e.vhall.com/domain string 嘉宾页面入口链接URL,访问此url跳转到组织者界面页面,使用Iframe嵌入或者直接跳转

响应示例

{
    "code": 200,
    "msg": "success",
    "data": 'http://e.vhall.com/webinar/host/654067993'
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10012 name或Email为空
10021 Email不合法
10022 name大于30个字符
10011 不是自己的活动
10050 服务器错误

webinar/current-online-number 获取当前在线人数

请求参数

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

响应参数

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

参数名 类型 必选 说明
num int 在线人数

响应示例

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

错误码

code 含义
10017 活动id为空
10010 活动不存在

report/online 获取在线人数

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
start_time int Linux时间戳,开始时间
end_time int Linux时间戳,结束时间

响应参数

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

参数名 类型 必选 说明
lists json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
total int 在线人数
time int 时间
{
    "code": 200,
    "msg": "success",
    "data": {
    	'total' : 100,
        'time'  : '2015-11-12 16:05:27'
    }
}

错误码

code 含义
10017 活动id为空
10010 活动不存在

report/attendee-records 获取直播活动用户访问记录

获取直播活动用户访问记录

URL http://e.vhall.com/api/vhallapi/v2/report/attendee-records

请求参数

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

响应参数

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

参数名 类型 必选 说明
lists json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
email string 邮箱
name string 昵称
ip string ip地址

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        'ip':'127.0.0.1',
	'name':'nelsonking',
        'email':'gaoyansing@sina.com'
    }
}

错误码

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

report/track 获取活动进入离开记录

获取活动进入离开记录

URL http://e.vhall.com/api/vhallapi/v2/report/track

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
pos int 数字,分页开始
limit int 数字,返回条数

响应参数

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

参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
name string 昵称
email string 邮箱
start_time string 进入时间,形式如2013-10-01 10:10:10
end_time string 离开时间

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'lists' : [
	    {
              'name' : 'nelsonking',
              'email': 'gaoyansing@sina.com',
              'start_time' : '2015-11-25 16:05:27',
              'end_time' : '2015-11-25 17:05:27'
            }
        ],
        'total': 1
	}
}

错误码

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

chat/history 获取活动对话

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID
pos int 分页开始 数字
limit int 返回条数 数字

响应参数

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

参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
webinar_id int 活动ID
name string 用户昵称
email string 用户邮箱
text string 对话内容
create_time string 对话时间形式如2013-10-01 10:10:10

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'lists': [
	        {
            	  'webinar_id' : 654067993,
                  'name' : 'v461',
                  'email': 'gaoyansing@sina.com',
                  'text': 'hello world',
                  'create_time' : '2015-11-12 16:05:27'
		},
	        {
            	  'webinar_id' : 654067993,
                  'name' : 'v461',
                  'email': 'gaoyansing@sina.com',
                  'text': 'hello every one',
                  'create_time' : '2015-11-12 16:05:29'
		},
	],
        'total':2
	}
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
open/todo_活动管理.txt · 最后更改: 2017/06/20 11:48 由 admin