活动管理

• webinar/create 创建活动
• webinar/start 获取发起直播页面URL
• webinar/fetch 获取活动信息
• webinar/state 获取活动状态
• webinar/list 获取活动列表
• webinar/update 更新活动信息
• webinar/stop 结束活动
• webinar/delete 删除活动
• guest/url 获取嘉宾/助理页面入口
• webinar/current-online-number 获取当前在线人数
• report/online 获取某个时间段内的在线人数
• report/attendee-records 获取直播活动用户访问记录
• webinar/report 活动统计
• report/track 获取活动观众观看记录
• chat/history 获取活动历史聊天记录
• chat/filter 对话过滤
• question/manage 获取问答管理url
• attendee/add-whitelist 添加活动观看白名单
• webinar/whole-auth-url 全局配置第三方K值验证URL
• webinar/activeimage 设置直播活动封面
• guest/add-authorization 添加嘉宾/助理权限接口
• guest/cancel-url 取消嘉宾/助理权限接口
• webinar/online-top-number 当前活动最高并发
• webinar/last-option-time 活动开始和结束时间
• webinar/top-online-by-times 按活动次数获取最高并发
• chat/send-comment 添加评论
• webinar/change-callback 设置活动状态变更通知回调接口
• webinar/change-callback-info 查询设置活动状态变更通知回调接口
• webinar/custom-broadcast 发送自定义广播消息

创建活动

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

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

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

获取发起直播页面URL

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

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/host/123456”}的json。data值的数据类型如下：

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

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

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

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

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

获取活动状态

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

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

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

获取活动列表

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

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

{
    "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': ''
    }
}

更新活动信息

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

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

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

结束活动，支持结束子账号创建的活动，如创建活动时auto_record为1，同时会自动生成当次直播的回放

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

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

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

删除活动，支持删除子账号创建的活动

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

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

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

获取嘉宾/助理页面入口

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

返回形如{“code”:200,”msg”:“success”,”data”:”'http://e.vhall.com/webinar/host/123456”}的json。data值的数据类型如下：

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

获取当前在线人数

URL http://e.vhall.com/api/vhallapi/v2/webinar/current-online-number 

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

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

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

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

返回形如{“code”:200,”msg”:“success”,”data”:[{'total':1,'time':'2012:12:12 12:12:12'}]}的json。data部分数据如下：

{
    "code": 200,
    "msg": "success",
    "data": [{
    	'total' : 100,
        'time'  : '2015-11-12 16:05:27'
    },
    {
    	'total' : 110,
        'time'  : '2015-11-12 16:06:27'
    }
    ]
}

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

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

返回形如{“code”:200,”msg”:“success”,”data”:{'ip':'127.0.0.1','name':'nelson','email':'gaoyan@vhall.com'}}的json。data部分数据如下：

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

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

返回形如{“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值的数据格式如下

响应示例

{
  "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
      }
    }
  }
}

错误码

获取活动观众观看记录

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

返回形如{“code”:200,”msg”:“success”,”data”:{'list':['name':'nelson','email':'gaoyan@vhall.com'],'total':1}}的json。data部分数据如下：

{
    "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
	}
}

获取活动历史聊天记录

URL http://e.vhall.com/api/vhallapi/v2/chat/history 

返回形如{“code”:200,”msg”:“success”,”data”:{'list':[{'webinar_id':123,'name':'nelson'}]},'total':1}的json。data部分数据如下：

{
    "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
	}
}

获取对话过滤页面入口

URL http://e.vhall.com/api/vhallapi/v2/chat/filter

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/chatfilter/123456789?vc=dfdf”}的json。data值的数据类型如下：

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

获取问答管理url

URL http://e.vhall.com/api/vhallapi/v2/question/manage 

返回形如{“code”:200,”msg”:“success”,”data”:“http://e.vhall.com/webinar/question/123456789?vc=dfdf”}的json。data值的数据类型如下：

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

添加活动观看白名单

URL http://e.vhall.com/api/vhallapi/v2/attendee/add-whitelist  

list参数：

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":[]
}

全局配置第三方K值验证URL，针对所有的活动配置生效，如果针对单个活动再做配置，以单个活动配置为最终配置。

URL http://e.vhall.com/api/vhallapi/v2/webinar/whole-auth-url  

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

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

设置直播活动封面

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

返回形如{“code”:200,”msg”:“success”,”data”:””: { “activeimage”: ”/activeimg/test.jpg”, “modifiedtime”:“2000-01-01 00:00:00”}}的json。data的数据如下：

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

添加嘉宾/助理权限接口，支持批量进行添加，但单次只允许全部添加成嘉宾或者全部添加成助理

URL http://e.vhall.com/api/vhallapi/v2/guest/add-authorization   

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

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

取消嘉宾/助理权限接口

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

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

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

当前活动最高并发

URL http://e.vhall.com/api/vhallapi/v2/webinar/online-top-number

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

相应示例

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

错误码

获取活动最近一次的开始和结束时间

URL http://e.vhall.com/api/vhallapi/v2/webinar/last-option-time

返回形如{“code”:200,”msg”:“success”,”data”:{“start_time”:“2016-09-0713:58:27”,”end_time”:“2016-09-0714:02:01”}}的json。data值的数据类型如下：

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "start_time": "2016-09-07 13:58:27",
        "end_time": "2016-09-07 14:02:01"
    }
}

错误码

按活动次数获取最高并发

URL http://e.vhall.com/api/vhallapi/v2/webinar/top-online-by-times 

返回形如{“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": [
    {
      "start_time": "2016-09-21 15:05:21",
      "num": 30
    },
    {
      "start_time": "2016-09-07 13:58:27",
      "num": 1
    }
  ]
}

URL http://e.vhall.com/api/vhallapi/v2/chat/send-comment 

返回形如{“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": 
}

设置活动状态变更通知回调接口

URL http://e.vhall.com/api/vhallapi/v2/webinar/change-callback 

返回形如

{
    "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值的数据格式如下

{
    "code":200,
    "msg":"success",
    "data":{
        "user_id":"1302",
        "webinar_id":0,
        "callback_url":"http://t.e.vhall.com/home/callback",
        "private_key":"abcdefg"
    }
}

查询设置活动状态变更通知回调接口

URL http://e.vhall.com/api/vhallapi/v2/webinar/change-callback-info 

返回形如

{
    "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值的数据格式如下

{
    "code":200,
    "msg":"success",
    "data":{
        "user_id":"1302",
        "webinar_id":0,
        "callback_url":"http://t.e.vhall.com/home/callback",
        "private_key":"abcdefg"
    }
}

发送自定义广播消息

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

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

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