帮助中心

活动管理

目录

webinar/create 创建活动

创建活动 URL http://e.vhall.com/api/vhallapi/v2/webinar/create

请求参数

参数名 类型 必选 说明
subject string <50个字符,活动主题
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为文档+视频,观看布局
type int 0为公开,1为非公开,个人公开/非公开活动
auto_record int 0为否,1为是(默认为否),是否自动回放
is_chat int 0为是,1为否(默认为是),是否开启聊天
host string <50个字符,可为空,主持人姓名
buffer int >0的数字,可为空,直播延时,单位为秒,默认为3
is_allow_extension int 默认为1表示开启并发扩展包,传其他参数表示不开启,流量套餐或没有并发扩展包时忽略此参数

响应参数

返回形如{“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个话题标签

webinar/start 获取发起直播页面URL

获取发起直播页面URL URL http://e.vhall.com/api/vhallapi/v2/webinar/start

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 9位数字
is_sec_auth【新】 int 是否开启地址安全验证,0位不开启,1位开启,默认为0,开启后获取的地址仅单次有效,离开地址再次进入需重新获取

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/host/123456”}的json。data值的数据类型如下:
类型 说明
string 主持人发起活动链接URL,访问此url跳转到组织者界面页面,使用Iframe嵌入或者直接跳转

响应示例

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

错误码

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

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码
password 活动密码设置
type 1为直播,2为预约,3为结束,4为点播,5 结束且有自动回放
topics 此活动的话题标签, 格式为 “标签1,标签2,标签3”
is_iframe 是否允许切入,1为允许切入
auto_record 是否自动回放,1为是,2为否
is_chat 是否允许聊天,默认0为允许,1为不允许
buffer 观看方延迟
t_start 开始时间
end_time 活动结束时间默认为 0000-00-00 00:00:00
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 活动当前为点播
5 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:点播,5:结束且有自动回放 不传递此参数则为所有活动,(如需组合查询,可将该值写成json字符串的形式。如status为[1,2](注意,4,5 不能使用数组形式)代表同时获取活动状态,活动状态

响应参数

返回形如{“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/update 更新活动信息

更新活动信息 URL http://e.vhall.com/api/vhallapi/v2/webinar/update

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID,9位数字
subject string 活动主题,<50个字符
start_time int 活动开始时间,Linux时间戳
use_global_k int 默认为0不开启,1为开启,是否针对此活动开启全局K值配置
exist_3rd_auth int 是否开启第三方K值验证查看说明,默认为0不开启,1为开启
auth_url string
introduction string 活动描述,<1024个字符
topics string 直播话题标签字段,以”,”(半角符号) 分割可以多个,标签最多为6个,单个标签不超过8个字 格式例: “商务,教育,视频教育”
layout int 观看布局,1为单视频,2为单文档,3为文档+视频
is_open int 活动公开状态,0为公开,1为非公开
auto_record int 是否自动回放,0为否,1为是
is_chat int 是否开启聊天,0为是,1为否
host string 主持人姓名,<50个字符,可为空
buffer int 直播延时,>0的数字,可为空

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:123456的json。data值的数据类型如下:
类型 说明
int 更新活动成功,返回9位数的活动ID

响应示例

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

错误码

code 含义
10010 活动不存在
10059 活动标题不能超过30个中文字符
10014 主持人姓名过长
10011 不是自己的活动
10016 k值验证的验证地址不能为空
10500 '更新失败
10832 缺少更新字段
12100 单个话题标签不能超过8个字
12101 最多只可添加6个话题标签

webinar/stop 结束活动

结束活动,支持结束子账号创建的活动,如创建活动时auto_record为1,同时会自动生成当次直播的回放 URL http://e.vhall.com/api/vhallapi/v2/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不是直播活动

webinar/delete 删除活动

删除活动,支持删除子账号创建的活动 URL http://e.vhall.com/api/vhallapi/v2/webinar/delete

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:123456的json。data值的数据类型如下:
类型 说明
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个字符,昵称
is_sec_auth【新】 int 是否开启地址安全验证,0位不开启,1位开启,默认为0,开启后获取的地址仅单次有效,离开地址再次进入需重新获取
type int 默认type=1获取的是嘉宾页面入口,type=2获取的是助理页面入口

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:”'http://e.vhall.com/webinar/host/123456}的json。data值的数据类型如下:
类型 说明
string 页面入口链接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 获取当前在线人数

获取当前在线人数 URL http://e.vhall.com/api/vhallapi/v2/webinar/current-online-number

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:20}的json。data值的数据类型如下:
类型 说明
int 在线人数

响应示例

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

错误码

code 含义
10017 活动id为空
10010 活动不存在
10801 当前接口30秒内只能访问一次

report/online 获取某个时间段内的在线人数

获取某个时间段内的在线人数 URL http://e.vhall.com/api/vhallapi/v2/report/online

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[{'total':1,'time':'2012:12:12 12:12:12'}]}的json。data部分数据如下:
参数名 类型 必选 说明
lists json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
total int 在线人数
time int 时间
{ "code": 200, "msg": "success", "data": [{ 'total' : 100, 'time' : '2015-11-12 16:05:27' }, { 'total' : 110, 'time' : '2015-11-12 16:06: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”:{'ip':'127.0.0.1','name':'nelson','email':'gaoyan@vhall.com'}}的json。data部分数据如下:
参数名 类型 必选 说明
lists json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
third_user_id 第三方用户id,与第三方创建用户传入的值一致
email string 邮箱
name string 昵称
ip string ip地址
refer string 来源信息,客户自定义的
state int 实际观看状态,1为观看,2为未观看

响应示例

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

错误码

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

webinar/report 活动统计

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

请求参数

参数名类型必选说明
webinar_id int 活动ID
time_span int 1 1周 2 近一月 3近三月 4 近半年 5 近一年 (默认一周)

响应参数

返回形如{“code”:“200”,”msg”:“\u6210\u529f”,”data”:{“total_attendee_number”:12,”total_watch_number”:3,”total_watch_times”:4,”total_watch_duration”:9,”list”:{“2016-01-25”:{“watch_times”:4,”watch_number”:3,”duration”:9}}}}的json,data值的数据格式如下

data数据

参数名 类型 必选 说明
total_attendee_number string 活动报名的总人数
total_watch_number string 活动观看的总人数
total_watch_times string 活动观看的总次数
total_watch_duration string 活动观看的总时长,精确到分钟
list string 每一天观看人数、观看次数以及观看时长的的list数据

list数据

参数名 类型 必选 说明
date string 日期
watch_number string 观看人数
watch_times string 观看次数
watch_duration string 观看时长
响应示例 { "code": "200", "msg": "成功", "data": { "total_attendee_number": 12, "total_watch_number": 4, "total_watch_times": 3, "total_watch_duration": 9, "list": { "2016-01-25": { "watch_times": 3, "watch_numbers": 4, "date": "2016-01-25", "watch_duration": 9 } } } } 错误码
code含义
10061 活动ID不能为空
10062 活动不存在
10815 当前地址5分钟内只能访问一次

report/track 获取活动观众观看记录

获取活动观众观看记录 URL http://e.vhall.com/api/vhallapi/v2/report/track

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
type int 1为直播,2为回放,默认为直播
pos int 数字,分页开始
limit int 数字,返回条数

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{'list':['name':'nelson','email':'gaoyan@vhall.com'],'total':1}}的json。data部分数据如下:
参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
third_user_id string 第三方用户id,与第三方创建用户接口中传入的值一致
name string 昵称
email string 邮箱
start_time string 进入时间,形式如2013-10-01 10:10
end_time string 离开时间,回放和点播时不返回此参数
duration string 观看时长
platform int 观看端类型,1为微吼直播App,2为WAP,3为PC,6为SDK

响应示例

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

错误码

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

chat/history 获取活动历史聊天记录

获取活动历史聊天记录 URL http://e.vhall.com/api/vhallapi/v2/chat/history

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID
start_time time 形如2016-11-30 10:16:43,只获取在该时间后的
end_time time 形如2016-11-30 10:16:43,只获取在该时间前的
pos int 分页开始 数字
limit int 返回条数 数字

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{'list':[{'webinar_id':123,'name':'nelson'}]},'total':1}的json。data部分数据如下:
参数名 类型 必选 说明
{“lists”:{},”total”:“10”} json 获取成功,返回列表数据(JSON格式)

list数据

参数名 类型 必选 说明
webinar_id int 活动ID
third_user_id string 第三方用户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, 'third_user_id':'12345678' '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 不是自己的活动

chat/filter 对话过滤

获取对话过滤页面入口 URL http://e.vhall.com/api/vhallapi/v2/chat/filter

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
email string <60个字符,邮箱格式,邮箱
name string <30个字符,昵称
is_sec_auth【新】 int 是否开启地址安全验证,0位不开启,1位开启,默认为0,开启后获取的地址仅单次有效,离开地址再次进入需重新获取

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/chatfilter/123456789?vc=dfdf”}的json。data值的数据类型如下:
类型 说明
string 页面入口链接URL,访问此url跳转到活动的对话过滤页面,使用Iframe嵌入或者直接跳转

响应示例

{ "code": 200, "msg": "success", "data": "http://e.vhall.com/webinar/chatfilter/123456789?vc=dfdf" }

错误码

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

question/manage 获取问答管理url

获取问答管理url URL http://e.vhall.com/api/vhallapi/v2/question/manage

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
email string <60个字符,邮箱格式,邮箱
name string <30个字符,昵称
is_sec_auth int 是否开启地址安全验证,0为不开启,1为开启,默认为0,开启后获取的地址仅单次有效,离开地址再次进入需重新获取

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/question/123456789?vc=dfdf”}的json。data值的数据类型如下:
类型 说明
string 页面入口链接URL,访问此url跳转到活动的对话过滤页面,使用Iframe嵌入或者直接跳转

响应示例

{ "code": 200, "msg": "success", "data": "http://e.vhall.com/webinar/question/123456789?vc=dfdf" }

错误码

code 含义
10017 活动id为空
10010 活动不存在
10018 name不能为空
10021 Email不合法
10022 name大于30个字符
10011 不是自己的活动
10050 服务器错误
500 生成VC参数有问题

attendee/add-whitelist 添加活动观看白名单

添加活动观看白名单 URL http://e.vhall.com/api/vhallapi/v2/attendee/add-whitelist

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
list JSON数组 添加的白名单列表,默认添加到此分组下,组名为:“导入”+webinar_id
list参数:
参数名 类型 说明
name string 姓名
industry string 行业名称
email string 邮箱
phone string 手机
list示例: [ { 'name' : 'gtest1', 'industry' : 'test1', 'email' : 'test1@sina.com', 'phone' : '12345678901' }, { 'name' : 'test2', 'industry' : 'test2', 'email' : 'test2@sina.com', 'phone' : '12345678901' } ]

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[]}的json。

响应示例

{ "code": 200, "msg": "success", "data":[] }

错误码

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

webinar/whole-auth-url 全局配置第三方K值验证URL

全局配置第三方K值验证URL,针对所有的活动配置生效,如果针对单个活动再做配置,以单个活动配置为最终配置。 URL http://e.vhall.com/api/vhallapi/v2/webinar/whole-auth-url

请求参数

参数名 类型 必选 说明
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(可选)
cover_child【新】 int 是否覆盖子账号,1为覆盖,0为不覆盖,默认为0

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[]}的json。

响应示例

{ "code": 200, "msg": "success", "data":[] }

错误码

code 含义
10050 服务器错误

webinar/activeimage 设置直播活动封面

设置直播活动封面 URL http://e.vhall.com/api/vhallapi/v2/webinar/activeimage

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
image file 图片内容.图片最大为1MB,支持的文件类型:jpg,gif,png,bmp,建议尺寸1280*720px

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:””: { “activeimage”: ”/activeimg/test.jpg”, “modifiedtime”:“2000-01-01 00:00:00”}}的json。data的数据如下:
参数名 类型 说明
activeimage string 上传成功后的图片地址
modifiedtime String 上传成功时间

响应示例

{ "code": 200, "msg": "success", "data":{ "activeimage":"webinars\/img_url\/52\/a6\/52a64ee1786a07aeaa5f5e0d27fe7cb5.jpg", "modifiedtime":"2016-01-26 14:47:41" } }

错误码

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

guest/add-authorization 添加嘉宾/助理权限接口

添加嘉宾/助理权限接口,支持批量进行添加,但单次只允许全部添加成嘉宾或者全部添加成助理 URL http://e.vhall.com/api/vhallapi/v2/guest/add-authorization

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
usersstring用户ID,多个用户ID,已英文逗号分割,一次最多条目为200
role_name int 用户角色 1 助理 2嘉宾

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[]}的json

响应示例

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

错误码

code 含义
10017 活动id为空
10060 用户ID不能为空
10111助手类型不能为空
10010 活动不存在
10011 不是自己的活动
10112 xxx这些会员不存在,数据未添加,请检测数据,此处的xxx表示请求参数users中没有匹配到的值
10113 不能对自身进行更改
10115单次导入数据不能超过200条

guest/cancel-url 取消嘉宾/助理权限接口

取消嘉宾/助理权限接口 URL http://e.vhall.com/api/vhallapi/v2/guest/cancel-url

请求参数

参数名 类型 必选 说明
webinar_id int 9位数字,活动ID
email string 用户邮箱或用户ID必须填写一个 <60个字符,邮箱格式,注意正确填写为设置“嘉宾/助理”的邮箱
user_id【新】 int 用户邮箱或用户ID必须填写一个 用户ID

响应参数

返回形如''{“code”:200,”msg”:“success”,”data”:””}的json

响应示例

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

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10114【新】 用户邮箱或用户ID必须填写一个
10050 服务器错误

webinar/online-top-number 当前活动最高并发

当前活动最高并发 URL http://e.vhall.com/api/vhallapi/v2/webinar/online-top-number

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:101}的json。data值的数据类型如下:
类型 说明
int 在线人数
相应示例 { "code": 200, "msg": "success", "data": 101 } 错误码
code含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10801 当前接口30秒内只能访问一次

webinar/last-option-time 活动开始和结束时间

获取活动最近一次的开始和结束时间 URL http://e.vhall.com/api/vhallapi/v2/webinar/last-option-time

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{“start_time”:“2016-09-0713:58:27”,”end_time”:“2016-09-0714:02:01”}}的json。data值的数据类型如下:
参数名 类型 必选 说明
start_time string 开始时间
end_time string 结束时间
相应示例 { "code": 200, "msg": "success", "data": { "start_time": "2016-09-07 13:58:27", "end_time": "2016-09-07 14:02:01" } } 错误码
code含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动

webinar/top-online-by-times 按活动次数获取最高并发

按活动次数获取最高并发 URL http://e.vhall.com/api/vhallapi/v2/webinar/top-online-by-times

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 9位数字
limit int 默认获取一条,最高50条

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[{“start_time”:“2016-09-21 15:05:21”,”num”:30},{“start_time”:“2016-09-07 13:58:27”,”num”:1}]}的json。data值的数据类型如下:
类型 说明
int 在线人数

响应示例

{ "code": 200, "msg": "success", "data": [ { "start_time": "2016-09-21 15:05:21", "num": 30 }, { "start_time": "2016-09-07 13:58:27", "num": 1 } ] }

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10101 获取条数不能超过50
10102 活动查询记录为空

chat/send-comment 添加评论

添加评论 URL http://e.vhall.com/api/vhallapi/v2/chat/send-comment

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID
content string 评论内容
user_id int 用户ID
nick_name string 用户昵称

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:[{“start_time”:“2016-09-21 15:05:21”,”num”:30},{“start_time”:“2016-09-07 13:58:27”,”num”:1}]}的json。data值的数据类型如下:

响应示例

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

错误码

code 含义
10017 活动ID为空
10806 内容为空
10807 用户ID为空
10809 昵称为空
10010 活动不存在
10011 不是自己的活动
10808 当前用户未参会

webinar/change-callback 设置活动状态变更通知回调接口

设置活动状态变更通知回调接口 URL http://e.vhall.com/api/vhallapi/v2/webinar/change-callback

请求参数

参数名 类型 必选 说明
callback_url string 回调通知地址
private_key string 回调接口验证私钥
webinar_id int 活动ID 活动ID不传时设置的是用户全局回调地址

响应参数

返回形如 { "code":200, "msg":"success", "data":{ "user_id":"1302", "webinar_id":0, "callback_url":"http://t.e.vhall.com/home/callback", "private_key":"abcdefg" } } 的json,data值的数据格式如下
参数名类型必选说明
user_id int 微吼用户ID
webinar_id int 微吼活动ID 活动ID为0时设置的是用户全局回调地址
callback_url string 回调通知地址
private_key string 回调接口验证私钥
响应示例 { "code":200, "msg":"success", "data":{ "user_id":"1302", "webinar_id":0, "callback_url":"http://t.e.vhall.com/home/callback", "private_key":"abcdefg" } } 错误码
code含义
12005 活动状态变更回调接口地址不能为空
12006 活动状态变更回调接口地址无法访问或者访问超时,请检查后再设置
12007 活动状态变更回调接口地址设置失败,请稍后重试
12008 活动状态变更回调接口地址不能超过255个字符
12009 私钥不能为空
12010 私钥不能超过255个字符
回调接口前置条件:
  • 普通列表项目如果用微吼主账号开启的直播需要调用主账号绑定第三方账号接口给主账号绑定第三方账号,否则主账号开启的直播因为缺失第三方账号信息不会通知回调接口。
回传第三方接口数据 { "channel": "vhall",//标识为微吼 "method": "webinar_type_change",//标识为状态变更 "webinarId": "858184439",//活动ID "type": "1",//暂时不用 "event":"start"//event=start为开始直播,event=stop为结束直播 "unionId": "testuser",//发起活动的第三方账号 "timestamp": "1504060666",//回调当时的时间戳 "signature": "6cbd9d3ffd1bcef4407558784fc1c80b"//签名 } 回调接口示例代码:
callback.php
<?php //PHP版本代码 $privateKey = 'abcdefg';//接口设置的private_key参数(回调接口验证私钥) data = $_POST; $sign = $data['signature']; unset($data['signature']); $sign_new = makeSignature($data , $privateKey);//调用签名生成函数 if($sign == $sign_new){ echo 'succ'; }else{ echo 'fail'; }   //$privateKey为回调接口私钥 //$data为回传的POST数据数组,剔除掉signature键值 //签名生成函数 function makeSignature(array $data, $privateKey){ ksort($data); $str = null; $privateKey = md5($privateKey); foreach ($data as $k => $v){ $str .= $k.'|'.$privateKey.'|'.$v; } return md5($str); } ?>

webinar/change-callback-info 查询设置活动状态变更通知回调接口

查询设置活动状态变更通知回调接口 URL http://e.vhall.com/api/vhallapi/v2/webinar/change-callback-info

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 活动ID不传时获取的是用户全局回调地址和私钥

响应参数

返回形如 { "code":200, "msg":"success", "data":{ "user_id":"1302", "webinar_id":0, "callback_url":"http://t.e.vhall.com/home/callback", "private_key":"abcdefg" } } 的json,data值的数据格式如下
参数名类型必选说明
user_id int 微吼用户ID
webinar_id int 微吼活动ID 活动ID为0时设置的是用户全局回调地址
callback_url string 回调通知地址
private_key string 回调接口验证私钥
响应示例 { "code":200, "msg":"success", "data":{ "user_id":"1302", "webinar_id":0, "callback_url":"http://t.e.vhall.com/home/callback", "private_key":"abcdefg" } } 错误码
code含义
12012 未设置活动状态变更回调接口地址