join_class_h5.js
8.0 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/**
* @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址
* @apiName joinClassH5
* @apiGroup meeting
* @apiVersion 1.6.0
* @apiDescription 获取h5页面课堂地址，如果课堂不存在，先创建该课堂
*
* @apiParam {String} siteId 站点标识
* @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64
* @apiParam {String} mtgTitle 课堂名称或者课堂主题，最大长度 32
* @apiParam {String} startTime 课堂的开始时间，作为课堂开始气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
* @apiParam {String} endTime 课堂的结束时间，作为课堂结束气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
* @apiParam {int} [language=2] 客户端语言：1 英文， 2 中文
* @apiParam {String} userName 客户端显示的姓名，最大长度 32
* @apiParam {String} userId 英文或数字组成的字符串，最大长度 50。等于0时是匿名用户，可以允许多个用户同时存在
* @apiParam {int} userType 用户类型： 8 普通与会者
* @apiParam {int} [meetingType=1] 1 互动 支持多人音视频，适用于小班授课 2 直播 适用于千人以上大课堂，不能进行音视频互动，支持H5网页观看
* @apiParam {String} hostPwd 主持人密码，密码长度 6 到 8 位，用于对普通人员申请主持人时的验证
* @apiParam {Long} timestamp 时间戳
* @apiParam {int} [h5Module] 是否启用 H5：1 启用，其它禁止。仅当站点开启 H5 功能时有效
* @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
*
* @apiSuccess {int} errorCode
* 0：正常 <br/>
* 1：siteId 错误，站点不存在或已删除 <br/>
* 2：站点未到生效日期 <br/>
* 3: 站点过期 <br/>
* 4：课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
* 5：用户信息 userName/userId/userType 不能为空 <br/>
* 6：timestamp 超时 <br/>
* 7：authId 错误 <br/>
* 8：authId 不能重复使用 <br/>
* 9：课堂开始或结束时间格式错误 <br/>
* 10：报文格式错误 <br/>
* 11: 该课堂没有开启h5
* @apiSuccess {String} url 课堂地址
* @apiSuccess {String} param 请将该节点下所有参数都拼接到url后面
* @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
* @apiSuccess {Long} timestamp 时间戳
*
* @apiParamExample {xml} 请求示例
<?xml version="1.0" encoding="UTF-8"?>
<param>
<siteId>shanghai</siteId>
<mtgKey>100012</mtgKey>
<mtgTitle>shanghai</mtgTitle>
<startTime>2015-08-12 14:00:00</startTime>
<endTime>2015-08-12 14:30:00</endTime>
<language>1</language>
<userName>shanghai</userName>
<userId>2000012</userId>
<userType>8</userType>
<meetingType>1</meetingType>
<h5Module>1</h5Module>
<hostPwd>123456</hostPwd>
<timestamp>1392032123210</timestamp>
<authId>4297f44b13955235245b2497399d7a93</authId>
</param>
*
* @apiSuccessExample {xml} 返回示例
<?xml version="1.0" encoding="UTF-8"?>
<result>
<errorCode>0</errorCode>
<url>http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp</url>
<param>
<siteId>admin</siteId>
<classID>1419338704</classID>
<userName>shanghai</userName>
<userId>2000012</userId>
<nopassword>false</nopassword>
<userType>8</userType>
<portalIP>127.0.0.1</portalIP>
<portalPort>8080</portalPort>
<md5>790a9c17892e99c89d6bef2cb1b5d2e6</md5>
</param>
<timestamp>1447815907543</timestamp>
<meetingNumber>1419338704</meetingNumber>
</result>
地址拼接：http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&classID=2043575585&userName=shanghai&userId=11111&userType=8&nopassword=false&portalIP=127.0.0.1&portalPort=8080&md5= 86e2b69e2919fb9592025f37f84f5066
*/
/**
* @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址
* @apiName joinClassH5
* @apiGroup meeting
* @apiVersion 2.0.0
* @apiDescription 获取h5页面课堂地址
*
* @apiParam {String} siteId 站点标识
* @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64
* @apiParam {String} mtgTitle 课堂名称或者课堂主题，最大长度 32
* @apiParam {String} startTime 课堂的开始时间，作为课堂开始气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
* @apiParam {String} endTime 课堂的结束时间，作为课堂结束气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
* @apiParam {int} [language=2] 客户端语言：1 英文， 2 中文
* @apiParam {String} userName 客户端显示的姓名，最大长度 32
* @apiParam {String} userId 英文或数字组成的字符串，最大长度 50。等于0时是匿名用户，可以允许多个用户同时存在
* @apiParam {int} userType 用户类型： 8 普通与会者
* @apiParam {int} [meetingType=1] 1 互动 支持多人音视频，适用于小班授课 2 直播 适用于千人以上大课堂，不能进行音视频互动，支持H5网页观看
* @apiParam {String} hostPwd 主持人密码，密码长度 6 到 8 位，用于对普通人员申请主持人时的验证
* @apiParam {Long} timestamp 时间戳
* @apiParam {int} [h5Module] 是否启用 H5：1 启用，其它禁止。仅当站点开启 H5 功能时有效
* @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
*
* @apiSuccess {int} errorCode
* 0：正常 <br/>
* 1：siteId 错误，站点不存在或已删除 <br/>
* 2：站点未到生效日期 <br/>
* 3: 站点过期 <br/>
* 4：课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
* 5：用户信息 userName/userId/userType 不能为空 <br/>
* 6：timestamp 超时 <br/>
* 7：authId 错误 <br/>
* 8：authId 不能重复使用 <br/>
* 9：课堂开始或结束时间格式错误 <br/>
* 10：报文格式错误 <br/>
* 11: 该课堂没有开启h5
* @apiSuccess {String} url 课堂地址
* @apiSuccess {String} param 请将该节点下所有参数都拼接到url后面
* @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
* @apiSuccess {Long} timestamp 时间戳
*
* @apiParamExample {xml} 请求示例
<?xml version="1.0" encoding="UTF-8"?>
<param>
<siteId>shanghai</siteId>
<mtgKey>100012</mtgKey>
<mtgTitle>shanghai</mtgTitle>
<startTime>2015-08-12 14:00:00</startTime>
<endTime>2015-08-12 14:30:00</endTime>
<language>1</language>
<userName>shanghai</userName>
<userId>2000012</userId>
<userType>8</userType>
<meetingType>1</meetingType>
<h5Module>1</h5Module>
<hostPwd>123456</hostPwd>
<timestamp>1392032123210</timestamp>
<authId>4297f44b13955235245b2497399d7a93</authId>
</param>
*
* @apiSuccessExample {xml} 返回示例
<?xml version="1.0" encoding="UTF-8"?>
<result>
<errorCode>0</errorCode>
<url>http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp</url>
<param>
<siteId>admin</siteId>
<classID>1419338704</classID>
<userName>shanghai</userName>
<userId>2000012</userId>
<nopassword>false</nopassword>
<userType>8</userType>
<portalIP>127.0.0.1</portalIP>
<portalPort>8080</portalPort>
<md5>790a9c17892e99c89d6bef2cb1b5d2e6</md5>
</param>
<timestamp>1447815907543</timestamp>
<meetingNumber>1419338704</meetingNumber>
</result>
地址拼接：http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&classID=2043575585&userName=shanghai&userId=11111&userType=8&nopassword=false&portalIP=127.0.0.1&portalPort=8080&md5=
*/