用户工具

站点工具


open:openapi_live_documents

目录

OpenAPI直播接入指南

一、直播API调用说明

1.介绍

本文档指导开发者通过微吼直播API业务,快速开发自身的直播需求;目前,接口包含直播API调用说明、活动API、互动API、数据API、文档API、问卷API、签到API、用户API、观众API、工具API和附录内容。

2.访问说明

2.1所有请求采用HTTP访问,使用POST方式。

2.2请使用UTF-8编码。

2.3所有返回结果使用JSON数据格式。

2.4使用此API前先联系客户经理开通权限,立即沟通权限申请

2.5获取API/SDK的使用权限信息,点击查看

3.接口定义

3.1接口URL

http://e.vhall.com/api/vhallapi/v1/{资源名}/{函数名}
http://e.vhall.com/api/vhallapi/v2/{资源名}/{函数名}
v2完全兼容v1, 它们的区别,如:
   webinar/list接口v1平台返回json:
   {"code":"200","msg":"成功","data":{"lists":"[{"webinar_id":87654321,"subject":"活动标题",  
"start_time":"2015-02-12 18:00:00","status":3,"desc":""}]","total":1}} 
   webinar/list接口v2平台返回json:
   {"code":"200","msg":"成功","data":{"lists":[{"webinar_id":87654321,"subject":"活动标题","start_time" 
 :"2015-02-12 18:00:00","status":3,"desc":""}],"total":1}}

3.2公共请求数据

参数名 类型 必选 说明
auth_type int 授权类型,1为验证帐号和密码(目前只通过帐号和密码验证),2为appkey/secretkey验证方式,使用说明见“5、签名方式调用”
account string auth_type为1时为必填项,用于登录e.vhall.com的帐号,是在“帐号设置”页面里查找到的“帐号”
password string auth_type为1时为必填项,用于登录e.vhall.com的密码,用于登录的密码

接口中必须包含公共请求参数,接口页面中只描述所需不同的请求参数!

3.3返回值说明

所有返回值一律为JSON格式,形如:

{'code':200,'data':****}

3.4响应示例PHP版

        $url = 'http://e.vhall.com/api/vhallapi/v2/webinar/create';//webinar为资源名,create为函数名
        $post_data = array(
            'auth_type'=>'1',
            'account'=>'vhall',
            'password'=>'XXXXX',
            'subject'=>'myvhall',
            'start_time'=>1376934451,
        );
        $data = http_build_query($post_data);
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_HEADER, 0);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_TIMEOUT, 6);
        $result = curl_exec($ch);
        curl_close($ch);
        var_dump($result);//操作成功,返回{'code':200,'data':'123456789'}

3.5签名方式调用

如果auth_type为2时,每个接口必须填写以下公共参数:

参数名 类型 必选 说明
auth_type int 授权类型,1为验证帐号和密码(目前只通过帐号和密码验证),2为appkey/secretkey验证方式
app_key string auth_type为2时为必填项, 点击获取app_key/secrect_key, 使用说明见“5、签名方式调用”
signed_at string auth_type为2时为必填项, unix时间戳
sign string auth_type为2时为必填项,见下面的生成规则

接口中必须包含公共请求参数,接口页面中只描述所需不同的请求参数!

参数sign的生成规则如下:

将接口中要求传递的所有参数(不包含sign,但包含auth_type、app_key、signed_at):

1按参数名升序排列
2然后按参数名1+参数值+参数名2+参数值拼接
3在首尾各加上secret_key
4计算md5作为sign

以接口”webinar_start_获取发起直播页面url”为例:点击查看接口说明 公共参数包括:auth_type、app_key、signed_at
专有参数包括:webinar_id
所以,在调用该接口时,应将上述所有参数一起签到sign中。
对于其他接口,公共参数部分不变,要将该接口的专有参数全部签入sign。

<?php
/****
 * 本示例代码是webinar_start_url接口的sign计算。
 * 其他接口所签参数依据该接口专有参数确定。
 */
$secret_key = "user_secret_key";
 
$params = [
	"app_key" => "user_app_key",
	"auth_type"=> 2,
	"signed_at" => "timestamp_now",
	"webinar_id" => "123456789",//这个参数是本接口专有参数,其他接口使用该接口的参数。
];
 
// 按参数名升序排列
ksort($params);
 
// 将键值组合
array_walk($params,function(&$value,$key){
	$value = $key . $value;
});
 
// 拼接,在首尾各加上$secret_key,计算MD5值
$sign = md5($secret_key . implode('',$params) . $secret_key);
 
// 结果形如
// $sign=md5("user_secret_keyapp_keyuser_app_keyauth_type2signed_attimestamp_nowwebinar_id123456789user_secret_key");
 
// 计算结果
// $sign = '4de932c67d65f26c6537ffb3a75401c3'; 

二、活动API

1.目录

2.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个字符,活动描述
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 子账号信息不存在

3.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个字符
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 缺少更新字段

4.webinar/stop 结束活动

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不是直播活动

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

5.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 不是自己的活动

备注:删除活动,支持删除子账号创建的活动。

6.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 没有活动

7.webinar/start 获取发起直播页面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 服务器错误

8.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 不是自己的活动

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

9.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 结束且有自动回放
is_single_video 是否单视频,1为是
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 不是自己的活动

备注:获取活动信息,支持获取子账号活动信息。

10.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 不是自己的活动

11.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 服务器错误

12.webinar/whole-auth-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 服务器错误

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

三、互动API

1.目录

2.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 服务器错误

3.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条

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

4.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 服务器错误

5.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 服务器错误

6.question/manage 获取问答管理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参数有问题

7.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 服务器错误

8.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 当前用户未参会

四、数据API

1.目录

2.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秒内只能访问一次

3.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 活动不存在

4.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 不是自己的活动

5.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分钟内只能访问一次

6.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 不是自己的活动

7.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 不是自己的活动

8.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秒内只能访问一次

9.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 活动查询记录为空

10.user/use-flow 用户流量查询

URL http://e.vhall.com/api/vhallapi/v2/user/use-flow 

请求参数

参数名 类型 必选 说明
user_id int 用户id
time_span int 时间跨度 1⇒ 7天,2 ⇒ 30天,3 ⇒ 90天,4 ⇒ 180天,5 ⇒: 360天

响应参数

参数名 类型 必选 说明
remain_flowstring剩余流量
total_flowstring使用总流量
total_record_flow string

list数据

参数名 类型 必选 说明
date string 时间
live_flow string 直播消耗流量
record_flow string 回放消耗流量

响应示例

{
    "code":"200",
    "msg":"成功",
    "data":{
        "remain_flow":98.78,
        "total_flow":6.28,
        "total_record_flow":0,
        "list":[
            {
                "date":"2017-01-09",
                "live_flow":0.12,
                "record_flow":0
            },
            {
                "date":"2017-01-08",
                "live_flow":0.04,
                "record_flow":0
            },
            {
                "date":"2017-01-06",
                "live_flow":0.02,
                "record_flow":0
            },
            {
                "date":"2017-01-05",
                "live_flow":1.04,
                "record_flow":0
            }
        ]
    }
}

错误码

code 含义
10060 用户ID不能为空
10116 time_span 参数不能为空
10060 不是自己的活动
10117 不属于自己的账号或子账号

五、文档API

1.目录

2.webinar/upload 文档上传

NEW 该API需线下对接

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

请求参数

参数名 类型 必选 说明
file string 文件URL

响应参数

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

参数名 类型 必选 说明
doc_id int 返回文档ID

响应示例

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

错误码

code 含义

3.webinar/document 获取文档目录

NEW 该API需线下对接

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

请求参数

参数名 类型 必选 说明
doc_id int 文档id

响应参数

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

参数名 类型 必选 说明
http://xxxx.com/dsfdfdd/1_m.jpg,http://xxxx.com/dsfdfdd/2_m.jpg array 地址数组

响应示例

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

错误码

code 含义
100001 xxxxx

4.webinar/page 文档翻页

NEW 该API需线下对接

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

请求参数

参数名 类型 必选 说明
hash string 文档标记
page int 第几页

响应参数

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

参数名 类型 必选 说明
thumb sting url

响应示例

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

错误码

code 含义

六、问卷API

1.目录

2.survey/list 获取问卷列表

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

请求参数

参数名 类型 必选 说明
user_id int 子账号id

响应参数

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

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

list数据

参数名 类型 必选 说明
id int 问卷ID
subject string 问卷标题
webinar_id int 活动id

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	{
        	'id':240,
		    'subject':'问卷1'
                      'webinar_id':'123456789'
        },
    	{
        	'id':240,
		    'subject','问卷1'
                      'webinar_id':'0'
        }
	}
}

当问卷相关活动id为空时,webinar_id返回0

错误码

code 含义
10104 子账号信息不存在
10019 查询数据为空

3.survey/reports 获取问卷ID对应问卷答案

URL http://e.vhall.com/api/vhallapi/v2/survey/reports 

请求参数

参数名 类型 必选 说明
ask_id int 问卷ID 由survey/list接口获取
user_id int 子账号id

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{'question':['姓名']},'answer':['v61']}的json。data部分数据如下:

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

list数据

参数名 类型 必选 说明
question array 问题数组
answer array 答案数组(有多个,对应问题数组的问题)

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'question':[
	        '姓名',
            '邮箱',
            '问答题',
            '1+1=?',
            '1+2=?'
        ],
	    'answer':[
			['v461','gaoyansing@sina.com','等于2','等于3']
		]
	}
}

错误码

code 含义
10027 问卷ID只能为大于等于0的数字
10104 子账号信息不存在
20027 没有找到此问卷,请稍后重试
20028 没有找到此问卷下的题目,请稍后重试

七、签到API

1.目录

1.report/sign-start 发起签到

NEW 该API需线下对接

URL http://e.vhall.com/api/vhallapi/v2/report/sign-start 

请求参数

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

响应参数

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

参数名 类型 必选 说明
sign_id int 返回签到ID

响应示例

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

错误码

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

2.report/sign 获取活动发起签到记录

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

请求参数

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

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{'list':[{'sign_id':11},{'sign_id':12}]},'total',2}的json。data部分数据如下:

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

list数据

参数名 类型 必选 说明
sign_id int 签到ID
create_time int 签到时间,形式如2013-10-01 10:10:10

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'lists' : [
			{
	        	'sign_id':136,
                'create_time':'2015-11-12 16:05:27'
			},
			{
	        	'sign_id':140,
                'create_time':'2015-11-12 16:06:27'
			}
		],
        'total': 2
	}
}

错误码

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

3.report/sign-record 获取签到ID记录

URL http://e.vhall.com/api/vhallapi/v2/report/sign-record 

请求参数

参数名 类型 必选 说明
sign_id int 签到ID,数字(由report/sign接口生成)
pos int 分页开始,数字
limit int 返回条数,数字

响应参数

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

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

list数据

参数名 类型 必选 说明
name string 签到昵称
email string 签到邮箱
create_time string 签到时间,形式如2013-10-01 10:10:10

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'lists' : [
			{
	        	'name':'nelson',
	        	'email':'gaoyansing@sina.com',
                'create_time':'2015-11-12 16:05:27'
			},
			{
	        	'name':'nelsonking',
	        	'email':'gaoyansing@sohu.com',
                'create_time':'2015-11-12 16:06:27'
			}
		],
        'total': 2
	}
}

错误码

code 含义
10017 签到id为空

八、用户API

1.目录

2.user/register 创建用户

URL http://e.vhall.com/api/vhallapi/v2/user/register

请求参数

参数名类型必选说明
third_user_id string 第三方用户ID,做为SDK DEMO里的帐号
pass string 用户密码,做为SDK DEMO里的密码
phone string 用户手机号
name string 用户昵称
email string 用户邮箱
head string 用户头像网络路径
customized_fieldstring API用户自己定义的一个字段,长度小于255个字符
customized_valuestring 上述自定义字段的值

响应参数

返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下

参数名类型必选说明
user_id int 微吼用户ID

相应示例

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

错误码

code含义
10070 第三方用户ID不能为空
10073 手机格式不对
10074 该手机号已存在
10021 邮箱格式不对
10077 密码不能为空
10078 密码为6-20位
10079 该邮箱已存在
10833 自定义字段过长
10834 自定义值过长

2.user/update 更新用户

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

请求参数

参数名类型必选说明
third_user_id string 第三方用户ID
pass string 更新密码
phone string 更新手机号
name string 更新昵称
email string 更新邮箱
head string 更新头像网络路径
customized_fieldstring API用户自己定义的一个字段,长度小于255个字符
customized_valuestring 上述自定义字段的值

响应参数

返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下

参数名类型必选说明
user_id int 微吼用户ID

响应示例

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

错误码

code含义
10070 第三方用户ID不能为空
10073 手机格式不对
10074 该手机号已存在
10076 邮箱格式不对
10078 密码为4-32位
10079 该邮箱已存在
10080 账户信息存在
10833 自定义字段过长
10834 自定义值过长

3.user/get-user-id 获取微吼用户ID

URL http://e.vhall.com/api/vhallapi/v2/user/get-user-id 

请求参数

参数名 类型 必选 说明
third_user_id string 第三方用户ID

响应参数

返回形如{“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值的数据类型如下:

类型 说明
id 微吼用户ID

响应示例

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

错误码

code 含义
10102 第三方用户ID不能为空
10103 第三方用户对象不存在

4.user/change-user-power 更改用户权限

URL http://e.vhall.com/api/vhallapi/v2/user/change-user-power 

请求参数

参数名 类型 必选 说明
user_id int 用户id
is_child int 是否是子帐号 1是 0不是
assign int 分配量,父账号是流量套餐时单位为(G)且可支持小数点后两位,父账号是并发套餐时单位为(人)仅支持整数

如需要用户具有直播权限,is_child请传1,assign大于0或在子账号管理中的用量分配方式修改为“动态”。

响应参数

返回形如{“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 含义
10102 用户ID不能为空
10103 第三方用户对象不存在
10104 子账号信息不存在
10105 分配量不能超过可用量
10106 子账号类型不对
10107 分配量不能为空
10108该认证用户未开通子账号权限
10830非第三方用户不能更改子账号选项

5.user/get-user-power 获取用户权限

URL http://e.vhall.com/api/vhallapi/v2/user/get-user-power 

请求参数

参数名 类型 必选 说明
user_id int 用户ID

响应参数

返回形如{“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值的数据类型如下:

is_child 是否是子账号 0 不是 1 是
assign 分配用量
role_id 角色ID

响应示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "is_child": 1,
    "assign": "10",
    "role_id" : 1
  }
}

错误码

code 含义
10102 用户ID不能为空
10103 第三方用户对象不存在
10104 子账号信息不存在
10831 当前查询数据非子账号数据拥有者

6.user/get-child-list 获取子账号列表

URL http://e.vhall.com/api/vhallapi/v2/user/get-child-list

请求参数

参数名 类型 必选 说明
source int 子账号创建来源,1为从微吼平台创建,2为通过接口创建,默认获取全部
pos int 数字,设置从第几条数据开始获取,如果是第一条数据(pos=0),默认为0
limit int 数字,每次返回条数

响应参数

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

参数名 类型 说明
user_id int 子账号的微吼用户id
source int 1为从微吼平台创建,2为通过接口创建
res_type int 用量类型,1为流量,2为并发
assign_mode int 用量分配方式,1为固定,2为动态
assign float 具体分配的并发或流量数,如assign_mode是2则不返回此参数

响应示例

{
      "code": "200",
      "msg": "成功",
      "data": [
          {
              "user_id": 981,
              "name": "xxxx",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 0
          },
          {
              "user_id": 982,
              "name": "木木的子账号",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 50
          }
      ]
  }

错误码

code说明
10819 无子账号数据
10820 当前主账号不是会员

7.user/get-user-info 获取用户信息

URL http://e.vhall.com/api/vhallapi/v2/user/get-user-info

请求参数

参数名类型必选说明
user_id string 微吼用户id
fields string 需要获取的字段,字段之间用英文逗号,分割

fields 参数详情

字段名 说明
name string 用户昵称
head string 用户头像的网络路径
customized_field string 第三方用户创建接口中传入的字段

响应参数

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

参数名类型说明
name string 用户昵称
head string 用户头像的网络路径,不传则返回微吼默认头像地址
customized_field string API用户自己定义的一个字段,长度小于255个字符
customized_value string 上述自定义字段的值

响应示例

  {
      "code": "200",
      "msg": "成功",
      "data": {
          "name": "xxxx",
          "head": "",
          "customized_field": "",
          "customized_value": ""
      }
  }

错误码

code说明
10103 第三方用户对象不存在

备注:获取用户信息,支持获取接口创建的用户以及微吼平台添加的子账号

8.attendee/set-status 改变用户状态-针对观众设置是否禁言

NEW 该API需线下对接

URL http://e.vhall.com/api/vhallapi/v2/attendee/set-status 

请求参数

参数名 类型 必选 说明
type int 1禁言,2解禁
join_id int 参会id

响应参数

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

参数名 类型 必选 说明

响应示例

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

错误码

code 含义

九、观众API

1.目录

1.verify/access-token 获取SDK直播操作token

URL http://e.vhall.com/api/vhallapi/v2/verify/access-token

请求参数

参数名 类型 必选 说明
app_keystring默认不传此参数,则获取的accessToken只适用于第1个应用;当用户开通多个app_key时,该参数为必选

响应参数

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

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

data数据

参数名 类型 必选 说明
timeLeft int 当前TOKEN剩余时间
accessToken string 访问TOKEN

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "timeLeft": 86400,
        "accessToken": "7d8ebefeec77ed411d5a17100ff3d860"
    }
}

错误码

code 含义
10040 验证出错
10030 身份验证出错

备注:取得SDK直播操token。此token在“自助式网络直播sdk”中使用

2.attendee/gen-token 参会用户token

URL http://e.vhall.com/api/vhallapi/v2/attendee/gen-token

请求参数

参数名 类型 必选 说明
webinar_id Int 活动ID
email String 邮箱,作为唯一标识
name String 昵称,仅作显示
app_keystring当用户开通多个app_key时,该参数为必选

响应参数

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

参数名 类型 必选 说明
token String 此token在观看sdk中使用

响应示例

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

错误码

code 含义

备注:取得参会用户token。此token在观看sdk中使用

十、工具API

1.目录

2.webinar/assistant-start-data 获取小助手启动协议

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

请求参数

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

响应参数

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

参数名 类型 必选 说明
data string 小助手启动协议

响应示例

{
    "code": 200,
    "msg": "success",
    "data": "vhalllive://vhalllive?stream_name=xxxxx"
}

错误码

code 含义
10017 活动id不能为空
11006 主持人信息为空,请添加主持人
11007 单文档无法使用助手发起

附录

错误码

code 含义
10000 账号或密码为空
10001 账号或密码错误
10002 Vhall正在审核API接入权限,接口暂不可用
10010 无此活动信息
10011 活动信息与用户信息不匹配
10012 必填字段缺失
10013 开始时间晚于结束时间
10014 主题为空或者超过50个字符
10015 公共密码格式错误,6-20位英文字母、数字或组合
10016 存在第三方K值验证,但是接口地址auth_url为空
10017 没有活动ID
10018 没有相关权限
10019 没有相关信息
10020 活动组织者不能以嘉宾身份进入
10021 邮箱格式不正确
10022 姓名超过30个字符
10023 没有录播ID
10024 活动状态不是进行中
10025 结束失败,稍候重试
10026 数据格式错误
10027 没有问卷ID
10028 活动进行中不能获取
10101 获取条目不能超过1000
10500 内部错误,稍候重试
open/openapi_live_documents.txt · 最后更改: 2017/08/25 18:42 由 xiaojiong