API参考 官网开发者

API简介

微吼SAASAPI是基于微吼SAAS平台提供便捷接入、功能全面、性能稳定、方式灵活服务。您可以通过SAASAPI，依照文档与自己服务进行集成，定制属于您自己的直播服务。SAASAPI平台让您告别复杂的架构设计和编程开发，使您可以专注于业务逻辑实现及最终用户体验的提升。

接入步骤

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

2、获取API/SDK的使用权限信息，点击查看

3、使用第2步中得到的Acess key，便可以访问微吼API中的全部接口服务，如果请求没有带上Acess key，微吼直播API的安全机制将会视其为未授权访问操作，并将其拦截。

Access Key

权限申请通过后，用户可在http://e.vhall.com/home/vhallapi/authlist 页面获取 appKey 和 secretKey。 说明：

appKey： 用于标识客户身份，在网络请求中会以某种形式传输

secretkey： 作为私钥形式存储于客户方本地， 不在网络传递，它的作用是对客户方发起的请求进行数字签名，保证该请求是来自指定客户的请求，并且是合法的有效的。

AppSecretKey:用于SDK,使用方式同secretkey

请求结构

公共参数

返回结果

签名机制

概述

API调用主要是通过用户向API的服务端地址发送HTTP GET请求，并按照接口说明填写相应的请求参数完成的。服务端接收到请求后，系统会按照请求的处理情况，返回处理结果。

主要根据以下四点来说明：

请求结构

公共参数

返回结果

签名机制

接口URL

微吼直播的接口地址为：

http://e.vhall.com/api/vhallapi/v2/{资源名}/{函数名}

webinar/list接口平台返回json：

{
	"code":"200",
	"msg":"成功",
	"data":{
		"lists":[
			{
				"webinar_id":87654321,
				"subject":"活动标题",
				"start_time" :"2015-02-12 18:00:00",
				"status":3,
				"desc":""
			}
		],
		"total":1
	}
}

通信协议

请求支持HTTP和HTTPS两种访问方式

请求方法

同时支持POST&GET方式，GET方式查询字符串（名称/值对）是在GET请求的URL中发送的，POST方式查询字符串（名称/值对）是在POST请求的HTTP消息主体中发送的。

请求参数

每个请求都需要包含的公共请求参数

字符编码

请使用UTF-8编码

公共请求参数

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

返回值

所有返回值一律为JSON格式，返回的 HTTP 状态码为 2xx，代表调用成功。返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。形如： {'code':200,'data':****}

成功结果示例

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

错误结果示例

"code": 500,
"msg": "服务请求错误",
"data": [],

响应示例PHP版

//webinar为资源名，create为函数名
$url = 'http://e.vhall.com/api/vhallapi/v2/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'}

错误码

概述

视频直播服务会对每个访问的请求进行身份验证，所以无论使用 HTTP 还是 HTTPS 协议提交请求，都需要在请求中包含签名（sign）信息。

签名步骤

如果auth_type为2时，视频直播通过使用appkey和secretkey进行对称加密的方法来验证请求的发送者身份,每个接口必须填写以下公共参数：

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

参数sign的生成规则如下：

将接口中要求传递的所有参数（不包含sign,但包含auth_type、app_key、signed_at）：

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

签名示例

/****
 * 本示例代码是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'; 

http://e.vhall.com/api/test

获取直播列表

创建直播

设置直播封面

第三方K值验证

更新直播信息

删除直播

获取发起直播页面URL

结束直播

查询直播信息

查询直播开始结束时间

查询直播状态

查询当前在线人数

查询某个时间段内的在线人数

查询当前直播最高并发

按直播次数查询最高并发

查询直播统计

查询直播观众观看记录

描述

创建直播

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取活动列表

接口地址

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": {
			'list':[
						{
							'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': '封面',
							 'topics':'话题'
						}
			]
    }
}

错误码

描述

获取个人主页直播列表

接口地址

http://e.vhall.com/api/vhallapi/v3/webinar/list

请求参数

注：非必传字段可以不传，但是不可以传空

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{"code":200,"msg":"success","data":{'total':15, 'total_page':2, 'curr_page':1, 'list':[]}的json。data部分数据如下：

响应示例

{
	"code": 200,
	"msg": "操作成功!",
	"data": {
		"total": 2,				//总条数
		"total_page": 1,			//总页数
		"curr_page": 1,				//当前页码
		"list": [
			{
				"webinar_id": 146954171,				//直播Id
				"subject": "test2",						//标题
				"start_time": "2020-08-19 15:30:54",	//开始时间	
				"desc": "我的直播哟",					//描述
				"thumb": "https://img_url/76d408c14736bb3370c788a93.png"	//封面图
			}
		]
	}
}

错误码

描述

设置直播封面

接口地址

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

错误码

描述

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

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

更新活动信息

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

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

接口地址

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/webinar/start

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

如果返回的域名是http ，建议处理成https ，此外ifame 地址需要添加 allow="camera *;microphone *;" 摄像机麦克风 权限

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

错误码

描述

结束直播，支持结束子账号创建的直播

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取直播信息，支持获取子账号直播信息

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

fields 参数详情

响应参数

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

响应示例

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

错误码

描述

查询最近一次直播的开始和结束时间

接口地址

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

错误码

描述

查询直播状态

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

状态码

响应示例

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

错误码

描述

查询直播当前在线人数

接口地址

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
}

错误码

描述

查询指定时间范围内观看直播的在线人数

接口地址

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部分数据如下：

list数据

响应示例

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

错误码

描述

查询直播最高并发

接口地址

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
}

错误码

描述

按直播场次查询最高并发

接口地址

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
    }
  ]
}

错误码

描述

查询直播统计

接口地址

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

data数据

list数据

响应示例

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

错误码

描述

获取直播观众观看记录

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

错误码

描述

获取推流地址

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/get-stream-push-address

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

响应示例

{
    "code": "200",
    "msg": "成功",
    "data": {
        "RTMP_URL": "rtmp://srs01.live.vhall.domain/vhall?vhost=thirdVhost?token=4DF79BB4t250BB",
        "STREAM_CODE": "415998879"
    }
}

错误码

描述

第三方推流开始活动

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

响应示例

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

错误码

描述

获取观众的报名表单记录

接口地址

http://e.vhall.com/api/vhallapi/v2/report/form

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{ "code": "200","msg": "成功","data": {"question": ["参会id","姓名",],"answer": [[924681,"1111"],[924747,"222222"] ],"total": 3}}的json。data部分数据如下：

list数据

错误码

描述

为直播上传文档，上传的文档会成为直播的默认文档

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/doc

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取每次直播开始和结束的时间记录

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{"lists":[{"start_time":"2019-01-01 10:00:00","end_time":"2019-01-01 11:00:00"},{"start_time":"2019-01-01 18:00:00","end_time":"未结束"}],"total":2}}''的json。data部分数据如下：

响应示例

{
	"code": 200,
	"msg": "success",
	"data": {
		"lists": [
			{
				"start_time": "2019-01-01 10:00:00",
				"end_time": "2019-01-01 11:00:00"
			},
			{
				"start_time": "2019-01-01 18:00:00",
				"end_time": "未结束"
			}
		],
		"total": 2
	}
}

描述

设置播放器跑马灯

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/set-player-text

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

设置播放器水印

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/set-player-watermark

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取播放器设置

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/get-player-config

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{"scrolling_text":{"text_type":1,"text":"test","alpha":50,"size":20,"color":"#ffffff","interval":20,"speed":3000,"position":1,"scrolling_open":1},"watermark":{"img_url":"test.jpg","img_alpha":50,"img_position":1,"watermark_open":1}}}''的json。data部分数据如下：

响应示例

{
	"code": 200,
	"msg": "success",
	"data": {
		"scrolling_text": {
			"text_type": 1,
			"text": "test",
			"alpha": 50,
			"size": 20,
			"color": "#ffffff",
			"interval": 20,
			"speed": 3000,
			"position": 1,
			"scrolling_open": 1
		},
		"watermark": {
			"img_url": "test.jpg",
			"img_alpha": 50,
			"img_position": 1,
			"watermark_open": 1
		}
	}
}

获取回放列表

设置默认回放

把回放发布为点播活动

生成回放

查询回放视频时长

描述

获取直播回放列表

接口地址

http://e.vhall.com/api/vhallapi/v2/record/list

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{'list':[{'id':123},{'id':321}],'total':2}''的json。data部分数据如下：

list数据

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'lists': [
        	{
            	'id': 654067993,
                'subject': 'test_record_name',
                'create_time': '2015-11-12 16:05:27',
                'duration':'600',
                'url' : 'http://e.vhall.com/webinar/webinar/record/654067993'
            }
        ],
        'total' : 1
	}
}

错误码

描述

设置默认回放

接口地址

http://e.vhall.com/api/vhallapi/v2/record/default

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{"code":200,"msg":"success","data":的json。

响应示例

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

错误码

描述

把回放发布为点播活动

接口地址

http://e.vhall.com/api/vhallapi/v2/webinar/create-webinar-from-record

请求参数

以上所有参数除了record_id,如果未填写则使用原直播的配置。

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","webinar_id":888}''的json。data值的数据类型如下：

错误码

没有细分具体的错误码，但是会分别给出错误信息

返回形如{“code”:400,”msg”:“回放id不能为空”}的json

描述

生成回放

接口地址

http://e.vhall.com/api/vhallapi/v2/record/create

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

查询回放视频时长

接口地址

http://e.vhall.com/api/vhallapi/v2/record/record-time

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{"code":200,"msg":"success","data":{"duration":281}}的json。data值的数据类型如下：

响应示例

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

错误码

描述

输入多个时间段，返回删除这些时间段的回放(合并为一个文件)。 注意：该接口仅用于初步裁剪，可能会有时间误差。如需要精细裁剪，请使用其它视频编辑工具。

接口地址

http://e.vhall.com/api/vhallapi/v2/record/cut

请求参数

list参数

list示例

[ { "start": 20, "end": 40 }, { "start": 60, "end": 80 } ]

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取回放下载地址

接口地址

http://e.vhall.com/api/vhallapi/v3/record/getDownloadUrl

请求参数

注：非必传字段可以不传，但是不可以传空

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。 **说明：**生成回放视频需要转码操作，可能时间比较长，回放视频时间越长，转码需要时间越长，所以需要传callback_url，生成成功之后会将下载地址异步回调到callback_url，视频保存时间为7天，如果此回放生成过视频文件，并且未过期，则会直接返回下载地址 回调会回传两个参数如下： { "record_id":"108071", //回放id "download_url":"http://t-ds.vhallyun.com/vhallda0220200827165116.zip" //回放下载地址 }

响应示例

{
	"code": 200,
	"msg": "操作成功!",
	"data": {
		"download_url": 2,					*//回放下载地址，如生成过的会直接返回下载地址，否则此字段返回空，通过异步回调callback_url回传下载地址*
	}
}

错误码

描述

获取分辨率信息接口

接口地址

http://e.vhall.com/api/v1/record/info

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

{
"msg": "操作成功!",
"code": 200,
"data": [
    {
        "quality": "same",
        "storage": 8.7  *//单位 M
    },
    {
        "quality": "a",   *//音频
        "storage": 0.7
    },
    {
        "quality": "720p",
        "storage": 6.1
    }
]

}

错误码

描述

分辨率转换接口

接口地址

http://e.vhall.com/api/v1/record/trans

请求参数

注：非必传字段可以不传，但是不可以传空

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。 **说明：**生成回放视频转码操作，可能时间比较长，回放视频时间越长，转码需要时间越长，所以需要传callback_url，生成成功之后会回调到callback_url通知， 回调会回传两个参数如下： { "record_id":"108071", //回放id "quality":"360" //360p "trans_status ":1 //转换结果 }

响应示例

{
	"code": 200,
	"msg": "操作成功!",
	"data": {}
}

错误码

描述

获取按回放分辨率下载地址

接口地址

http://e.vhall.com/api/v1/record/download

请求参数

注：非必传字段可以不传，但是不可以传空

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。 **说明：**生成回放视频需要转码操作，可能时间比较长，回放视频时间越长，转码需要时间越长，所以需要传callback_url，生成成功之后会将下载地址异步回调到callback_url，视频保存时间为7天，如果此回放生成过视频文件，并且未过期，则会直接返回下载地址 回调会回传两个参数如下： { "record_id":"108071", //回放id 'quality' : '清晰度', //清晰度 "download_url":"http://t-ds.vhallyun.com/vhallda0220200827165116.zip" //回放下载地址 }

响应示例

{
	"code": 200,
	"msg": "操作成功!",
	"data": {
	    "record_id":"108071",  
		"download_url": '',					*//回放下载地址，如生成过的会直接返回下载地址，否则此字段返回空，通过异步回调callback_url回传下载地址*
	}
}

错误码

创建用户

更新用户

获取用户权限

更改用户权限

获取用户信息

获取微吼用户ID

获取子账号列表

查询用户流量

按场次查询用户直播并发数据

查询用户每天直播并发数据

描述

创建用户

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

更新用户

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取用户权限

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{"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": {
    "is_child": 1,
    "assign": "10",
    "role_id" : 1
  }
}

错误码

描述

更改第三方账号权限，支持修改分配给第三方用户的套餐使用量

接口地址

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

请求参数

如需要用户具有直播权限，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": []
}

错误码

描述

获取第三方用户信息

接口地址

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

请求参数

fields 参数详情

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取微吼用户ID

接口地址

http://e.vhall.com/api/vhallapi/v2/user/get-user-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值的数据类型如下：

响应示例

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

错误码

描述

获取子账号列表

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

{
      "code": "200",
      "msg": "成功",
      "data": [
          {
              "user_id": 981,
              "name": "xxxx",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 0,
  		"phone":'13211111111',			//手机号
  	 	"email":"13123@sina.com"		//邮箱
          },
          {
              "user_id": 982,
              "name": "木木的子账号",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 50,
		"phone":'13211111111',			//手机号
		"email":"13123@sina.com"		//邮箱
          }
      ]
  }

错误码

描述

统计用户账号的流量

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

list数据

响应示例

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

错误码

描述

按场次查询用户直播并发数据

接口地址

http://e.vhall.com/api/vhallapi/v2/user/concurrent-audience

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

查询用户每天并发数

接口地址

http://e.vhall.com/api/vhallapi/v2/user/concurrent-date

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

获取SDK推流token

获取SDK观看token

描述描述

取得SDK直播的Token。此Token在“自助式网络直播sdk”中使用

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

data数据

响应示例

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

错误码

概述

取得参会用户Token。此Token在观看sdk中使用

接口地址

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

请求参

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

描述

发送自定义广播消息

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

获取嘉宾/助理页面

添加嘉宾/助理权限

取消嘉宾/助理权限

描述

获取嘉宾/助理页面

接口地址

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'
}

错误码

描述

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

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

取消嘉宾/助理权限

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取嘉宾/助理页面

接口地址

http://e.vhall.com/api/vhallapi/v2/guest/password

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如{"code":"200","msg":"success","data":{"assistant_password":"111111","guest_password":"111111","host_password":"111111"}}的json。

fields 参数详情

响应参数

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

响应示例

{
	"code": "200",
	"msg": "成功",
	"data": {
		"assistant_password": "733686",
		"host_password": "184532"
	}
}

错误码

描述

1、获取主持人/嘉宾的客户端私有协议，返回链接可唤起客户端 2、针对H5活动，建议用户自己开发如下页面，同时支持网页和客户端进行直播。主持人和嘉宾均适用

接口地址

http://e.vhall.com/api/vhallapi/v2/guest/client-protocol

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

{
	"code": "200",
	"msg": "成功",
	"data": {
		"url": ""
	}
}

错误码

添加观看直播白名单

描述

添加观看直播白名单

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

list参数

list示例

             [
                {
                    'name' : 'gtest1',
                    'industry' : 'test1',
                    'email' : 'test1@sina.com',
                    'phone' : '12345678901',
					'job_number':1,
					'other':'333'
                },
                {
                    'name' : 'test2',
                    'industry' : 'test2',
                    'email' : 'test2@sina.com',
                    'phone' : '12345678901',
					'job_number':1,
					'other':'333'
                }
             ]

响应参数

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

响应示例

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

错误码

描述

将直播的观看限制设为白名单

接口地址

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

请求参数

注：暂不支持设置免费和白名单以外的观看限制

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

响应示例

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

错误码

描述

获取已设置的白名单列表

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{'name':'姓名','industry':'行业'，'email':'邮箱','phone':'手机'}''的json。data部分数据如下：

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'name': '姓名',
        'industry': '行业',
        'email' : '邮箱',
        'phone': '手机',
		'job_number':1,
		'other':'333'
    }
}

错误码

获取直播聊天页面

获取直播历史聊天记录

添加回看评论

描述

获取直播聊天过滤页面

接口地址

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

错误码

描述

获取直播历史聊天记录

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

响应示例

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

错误码

描述

添加直播回放评论。（因业务变更，此接口已废弃）

接口地址

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

错误码

描述

批量添加聊天、评论中自动过滤的关键词

接口地址

http://e.vhall.com/api/vhallapi/v2/chat/add-keywords

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

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

错误码

描述

清空已经添加的所有关键词

接口地址

http://e.vhall.com/api/vhallapi/v2/chat/clear-keywords

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

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

描述

获取已经添加的所有关键词

接口地址

http://e.vhall.com/api/vhallapi/v2/chat/get-keywords

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

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

获取问答管理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"
}

错误码

获取问卷列表

获取问卷ID对应问卷答案

描述

获取问卷列表

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

响应示例

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

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

错误码

描述

获取问卷ID对应问卷答案

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

响应示例

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

错误码

获取活动发起签到记录

获取签到ID记录

描述

获取活动发起签到记录

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

响应示例

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

错误码

描述

获取签到ID记录

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

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

list数据

响应示例

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

错误码

回调简介

签名方法

设置回调事件

查询回调事件

回调消息

简介

每个直播状态的变化、每个回放的生成、每次视频转码完成，这些事件状态的变化对于用户来说都是至关重要的，为了及时将这些重要信息告知用户，我们提供了通过API主动推送消息的服务。

在使用回调服务前您需要先设置回调事件，当有事件发生时，接口会通过HTTP POST的方式将事件的状态变化发送到您的服务器上，事件内容为JSON格式。方法详见设置回调事件。

目前微吼提供的主动推送消息有：

1、直播开始结束

2、JSSDK 上传视频完成创建回放

3、JSSDK 上传视频完成转码

描述

API签名主要使用在系统间进行交互时，采用API签名，可以保证请求的数据准确性和接口的安全性。

签名步骤

使用请求参数构造规范化的请求字符串（Canonicalized Query String）

a)　按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到signature参数本身）进行排序。

注：当使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即URI中“?”之后由“&”连接的部分）。

b)　对每个请求参数的名称和值进行编码。名称和值要使用UTF-8字符集进行URL编码，URL编码的编码规则是：

• 对于字符 A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码；

c)　对编码后的参数名称、私钥和值使用英文等号（|）进行连接。

d)　再把英文竖线连接得到的字符串按参数名称的字典顺序依次连接，即得到规范化字符串。

使用上一步构造的规范化字符MD5计算，即得到签名的字符串：

签名方法示例

//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);
}

描述

进行回调事件设置，通过事件设置用户可以实现需要对哪些事件的消息进行回调

接口地址

http://e.vhall.com/api/vhallapi/v2/callback/set-event

请求参数

secret_key：数据传输私钥，在签名中进行使用

callback_url：指定一个接收消息通知的URL(开发者提供)

callback_event：1、直播开始，结束回调通知 2、JSSDK 上传视频完成创建回放成功后通知 3、JSSDK 上传视频完成转码后通知

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

JASON格式

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

错误码

描述

查询设置的回调事件

接口地址

http://e.vhall.com/api/vhallapi/v2/callback/event-info

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

private_key：查询数据传输私钥

callback_event：1、直播开始，结束回调通知 2、JSSDK 上传视频完成创建回放成功后通知 3、JSSDK 上传视频完成转码后通知

响应示例

JASON格式

{
    "code": "200",
    "msg": "成功",
    "data": {
        "callback_url": "http://www.domain.com/api/callback",
        "callback_event": "2,3",
        "secret_key": "abcedfg"
    }
}

错误码

消息组织格式

通知信息是以 JSON 格式进行组织的，注意这里的 POST 格式的 ContentType 是 application/json。

公共头信息

如下的字段是每种类型的通知消息都一定会携带的：

示例

	User-Agent: vhall
	Content-Type: application/json
	Content-Length: content length

各事件消息体

直播开始结束回调通知

callback_event=1 代表直播开始、结束，同时消息体会额外包含如下信息：

type:代表返回的直播状态，1代表开始 3代表结束

示例

{
    method_id: 1, // 回调事件ID
    refer: "vhall", // 来源
    time: 1505095994, // 当前时间戳
    webinar_id: 123456,  // 直播ID
    third_user_id : 123456 // 第三方用户ID （无第三方账户，返回空字符串）
    type : 1 // 直播状态 1 开始 3 结束
    signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名
}

JSSDK 上传视频完成创建回放

callback_event=2 代表JSSDK 上传视频完成创建回放，同时消息体会额外包含如下信息：

示例

{
    method_id: 2, // 回调事件ID
    refer: "vhall", // 来源
    time: 1505095994, // 当前时间戳
    record_id: 56345,  // 回放ID
    signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名
}

JSSDK 上传视频完成转码

callback_event=3 代表JSSDK 上传视频完成转码，同时消息体会额外包含如下信息：

status:视频转码状态，1代表成功，3代表失败

示例

{
    method_id: 3, // 回调事件ID
    refer: "vhall", // 来源
    time: 1505095994, // 当前时间戳
    record_id: 56345,  // 回放ID
    status: "3", // 转码状态 1 成功 3 失败
    signature: "58d85e40c577596c49e0217e2297728, // 签名
}

描述

获取抽奖列表

接口地址

http://e.vhall.com/api/vhallapi/v2/report/lottery

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{{' lottery_id ':0001,'time':'2018-06-01 10:34:41',‘winner_number’:5},{'' lottery_id ':0002,'time':'2018-06-02 11:34:41',‘winner_number’:8}}''的json。。data部分数据如下：

list数据

响应示例

{ "code": 200, "msg": "success", "data": { { ' id ':0001, 'time':'2018-06-01 10:34:41', 'num':5 }, { ' id ':0002, 'time':'2018-06-01 10:34:41', 'num':5 } } }

错误码

描述

获取抽奖详情

接口地址

http://e.vhall.com/api/vhallapi/v2/report/lottery-details

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":‘time’:[抽奖时间],’nickname’:[昵称], ’name’:[姓名],’phone’:[手机]}''的json。data部分数据如下：

list数据

响应示例

{ "code": 200, "msg": "success", "data":{ ‘time’:[ 2018-05-06 18:34:41],’ nickname’:[明明],’ name’:[张小明],’ phone’:[13198761005] } }

错误码

描述

获取专题列表

接口地址

http://e.vhall.com/api/vhallapi/v2/subject/list

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

{
 "code": "200","msg": "成功",
 "data": {
	"lists": [
   {
     "id": 910928344,//专题id
      "title": "专题1",//标题
      "intro": "",//简介
      "created_at": "2018-10-18 16:50:30",//创建时间
       "url": ""//封面图地址
        }
    ],
   	 "total": 1
}

}

错误码

描述

获取专题内的直播列表

接口地址

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

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

{
	"code": "200","msg": "成功",
 "data": {
   "lists": [
 {
 "webinar_id": 408330878,//活动id
"subject": "专题1",//标题
 "start_time": "2018-06-28 16:04:00",//开始时间
 "desc": "",//简介
 "thumb": ""//封面
},
 {
 "webinar_id": 769883142,
 "subject": "专题1",
"start_time": "2018-06-27 14:13:00",
"desc": "专题1",
  "thumb": ""
}
 ],
"total": 2
}

}

错误码

描述

获取个人主页专题列表

接口地址

http://e.vhall.com/api/vhallapi/v3/subject/list

请求参数

注：非必传字段可以不传，但是不可以传空

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应示例

{
	"code": 200,
	"msg": "操作成功!",
	"data": {
		"total": 2,					*//总条数*
		"total_page": 1,			*//总页数*
		"curr_page": 1,				*//当前页码*
		"list": [
			{
				"id": 146954171,			//专题id
				"title": "test2",			//标题
				"intro": "test2",			//简介
				"create_time": "2020-08-19 15:30:54",		//创建时间
				"url": "https://img_url/76d408c14736bb3370c788a93.png"	//封面图地址
			},
			{
				"id": 390607278,
				"title": "test1",
				"intro": "",
				"create_time": "2020-05-27 17:54:20",
				"url": ""
			}
		]
	}
}

错误码

描述

获取红包列表

接口地址

http://e.vhall.com/api/vhallapi/v2/redpacket/package

请求参数

接口中必须包含公共请求参数。关于公共请求参数详细内容，请参考 公共请求参数。

响应参数

返回形如''{"code":200,"msg":"success","data":{红包信息}''的json。data部分数据如下：

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
    	'account_red_packet':{
			  "account_id": 16421841,
			 "account_type": 0,
			 "webinar_id": 132214494,
			 "red_packet_send_time": "2020-06-26 23:10:04",
			 "red_packet_money": "0.01",
			 "red_packet_count": 1,
			 "red_packet_type": 0,
			 "red_packet_pay_status": 1
		},
		'son_account_red_packet':{
		
		}
    }
}

错误码

API