正在显示
2 个修改的文件
包含
103 行增加
和
14 行删除
src/joinClassApp.js
0 → 100644
1 | +/** | ||
2 | + * @api {post} /3m/meeting/join_mtg_app.do 4.app获取课堂信息 | ||
3 | + * @apiName joinClassApp | ||
4 | + * @apiGroup meeting | ||
5 | + * @apiVersion 1.6.0 | ||
6 | + * @apiDescription app获取课堂信息,如果课堂不存在,先创建该课堂 | ||
7 | + * | ||
8 | + * @apiParam {String} siteId 站点标识 | ||
9 | + * @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64 | ||
10 | + * @apiParam {String} mtgTitle 课堂名称或者课堂主题,最大长度 32 | ||
11 | + * @apiParam {String} startTime 课堂的开始时间,作为课堂开始气泡提示的参考时间。格式为:YYYY-MM-DD HH:MM:SS | ||
12 | + * @apiParam {String} endTime 课堂的结束时间,作为课堂结束气泡提示的参考时间。格式为:YYYY-MM-DD HH:MM:SS | ||
13 | + * @apiParam {int} [language=2] 客户端语言:1 英文, 2 中文 | ||
14 | + * @apiParam {String} userName 客户端显示的姓名,最大长度 32 | ||
15 | + * @apiParam {String} userId 英文或数字组成的字符串,最大长度 50。等于0时是匿名用户,可以允许多个用户同时存在 | ||
16 | + * @apiParam {int} userType 用户类型: 8 普通与会者 | ||
17 | + * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 | ||
18 | + * @apiParam {Long} timestamp 时间戳 | ||
19 | + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key | ||
20 | + * | ||
21 | + * @apiSuccess {int} errorCode | ||
22 | + * 0:正常 <br/> | ||
23 | + * 1:siteId 错误,站点不存在或已删除 <br/> | ||
24 | + * 2:站点未到生效日期 <br/> | ||
25 | + * 3: 站点过期 <br/> | ||
26 | + * 4:课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/> | ||
27 | + * 5:用户信息 userName/userId/userType 不能为空 <br/> | ||
28 | + * 6:timestamp 超时 <br/> | ||
29 | + * 7:authId 错误 <br/> | ||
30 | + * 8:authId 不能重复使用 <br/> | ||
31 | + * 9:课堂开始或结束时间格式错误 <br/> | ||
32 | + * 10:报文格式错误 <br/> | ||
33 | + * @apiSuccess {String} url 课堂地址 | ||
34 | + * @apiSuccess {String} param | ||
35 | + * @apiSuccess {String} siteId | ||
36 | + * @apiSuccess {String} classID 课堂 id | ||
37 | + * @apiSuccess {String} userName | ||
38 | + * @apiSuccess {String} userId | ||
39 | + * @apiSuccess {String} userType | ||
40 | + * @apiSuccess {String} nopassword 是否需要验证密码 False:不需要验证 True: 需要验证 | ||
41 | + * @apiSuccess {String} portalIP 服务器ip | ||
42 | + * @apiSuccess {String} portalPort 服务器端口 | ||
43 | + * @apiSuccess {String} md5 返回的md5 | ||
44 | + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号 | ||
45 | + * @apiSuccess {Long} timestamp 时间戳 | ||
46 | + * | ||
47 | + * @apiParamExample {xml} 请求示例 | ||
48 | + <param> | ||
49 | + <siteId>shanghai</siteId> | ||
50 | + <mtgKey>100012</mtgKey> | ||
51 | + <mtgTitle>shanghai</mtgTitle> | ||
52 | + <startTime>2015-08-12 14:00:00</startTime> | ||
53 | + <endTime>2015-08-12 14:30:00</endTime> | ||
54 | + <language>1</language> | ||
55 | + <userName>shanghai</userName> | ||
56 | + <userId>2000012</userId> | ||
57 | + <userType>8</userType> | ||
58 | + <hostPwd>123456</hostPwd> | ||
59 | + <timestamp>1392032123210</timestamp> | ||
60 | + <authId>4297f44b13955235245b2497399d7a93</authId> | ||
61 | + </param> | ||
62 | + * | ||
63 | + * @apiSuccessExample {xml} 返回示例 | ||
64 | + <?xml version="1.0" encoding="UTF-8"?> | ||
65 | + <result> | ||
66 | + <errorCode>01</errorCode> | ||
67 | + <url>http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp</url> | ||
68 | + <param> | ||
69 | + <siteId>admin</siteId> | ||
70 | + <classID>1419338704</classID> | ||
71 | + <userName>shanghai</userName> | ||
72 | + <userId>2000012</userId> | ||
73 | + <nopassword>false</nopassword> | ||
74 | + <userType>8</userType> | ||
75 | + <portalIP>127.0.0.1</portalIP> | ||
76 | + <portalPort>8080</portalPort> | ||
77 | + <md5>790a9c17892e99c89d6bef2cb1b5d2e6</md5> | ||
78 | + </param> | ||
79 | + <timestamp>1447815907543</timestamp> | ||
80 | + <meetingNumber>1419338704</meetingNumber> | ||
81 | + </result> | ||
82 | + * 获取到param下的参数传给学点云app | ||
83 | + */ | ||
84 | + | ||
85 | +/** | ||
86 | + * @api {post} /3m/meeting/join_mtg_app.do 4.app获取课堂信息 | ||
87 | + * @apiName joinClassApp | ||
88 | + * @apiGroup meeting | ||
89 | + * @apiVersion 2.0.0 | ||
90 | + * @apiDeprecated 请使用 /3m/meeting/join_mtg.do | ||
91 | + * @apiDescription app获取课堂信息 | ||
92 | + */ |
@@ -16,25 +16,22 @@ | @@ -16,25 +16,22 @@ | ||
16 | * @apiParam {int} userType 用户类型: 8 普通与会者 | 16 | * @apiParam {int} userType 用户类型: 8 普通与会者 |
17 | * @apiParam {int} [meetingType=1] 1 互动 支持多人音视频,适用于小班授课 2 直播 适用于千人以上大课堂,不能进行音视频互动,支持H5网页观看 | 17 | * @apiParam {int} [meetingType=1] 1 互动 支持多人音视频,适用于小班授课 2 直播 适用于千人以上大课堂,不能进行音视频互动,支持H5网页观看 |
18 | * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 | 18 | * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 |
19 | - * @apiParam {String} docID 暂不支持 | ||
20 | - * @apiParam {String} mediaID 暂不支持 | ||
21 | - * @apiParam {String} [backUrl] 暂不支持 | ||
22 | * @apiParam {Long} timestamp 时间戳 | 19 | * @apiParam {Long} timestamp 时间戳 |
23 | * @apiParam {int} [h5Module] 是否启用 H5:1 启用,其它禁止。仅当站点开启 H5 功能时有效 | 20 | * @apiParam {int} [h5Module] 是否启用 H5:1 启用,其它禁止。仅当站点开启 H5 功能时有效 |
24 | * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key | 21 | * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key |
25 | * | 22 | * |
26 | * @apiSuccess {int} errorCode | 23 | * @apiSuccess {int} errorCode |
27 | - * 0:正常 <br/>; | ||
28 | - * 1:siteId 错误,站点不存在或已删除 <br/>; | ||
29 | - * 2:站点未到生效日期 <br/>; | ||
30 | - * 3: 站点过期 <br/>; | ||
31 | - * 4:课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>; | ||
32 | - * 5:用户信息 userName/userId/userType 不能为空 <br/>; | ||
33 | - * 6:timestamp 超时 <br/>; | ||
34 | - * 7:authId 错误 <br/>; | ||
35 | - * 8:authId 不能重复使用 <br/>; | ||
36 | - * 9:课堂开始或结束时间格式错误 <br/>; | ||
37 | - * 10:报文格式错误 <br/>; | 24 | + * 0:正常 <br/> |
25 | + * 1:siteId 错误,站点不存在或已删除 <br/> | ||
26 | + * 2:站点未到生效日期 <br/> | ||
27 | + * 3: 站点过期 <br/> | ||
28 | + * 4:课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/> | ||
29 | + * 5:用户信息 userName/userId/userType 不能为空 <br/> | ||
30 | + * 6:timestamp 超时 <br/> | ||
31 | + * 7:authId 错误 <br/> | ||
32 | + * 8:authId 不能重复使用 <br/> | ||
33 | + * 9:课堂开始或结束时间格式错误 <br/> | ||
34 | + * 10:报文格式错误 <br/> | ||
38 | * 11: 该课堂没有开启h5 | 35 | * 11: 该课堂没有开启h5 |
39 | * @apiSuccess {String} url 课堂地址 | 36 | * @apiSuccess {String} url 课堂地址 |
40 | * @apiSuccess {String} param | 37 | * @apiSuccess {String} param |
-
请 注册 或 登录 后发表评论