lipengjava

udpate join mtg 2.1.0

@@ -19,7 +19,6 @@ @@ -19,7 +19,6 @@
19 * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 19 * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证
20 * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取 20 * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取
21 * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取 21 * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取
22 - * @apiParam {String} sharedMediaID 媒体共享文件唯一标识。多个标识用英文逗号分隔。标识通过查询媒体共享文件接口获取  
23 * @apiParam {String} [backUrl] 课堂结束后的回调地址 22 * @apiParam {String} [backUrl] 课堂结束后的回调地址
24 * @apiParam {Long} timestamp 时间戳 23 * @apiParam {Long} timestamp 时间戳
25 * @apiParam {int} [docModule] 是否启用文档共享:1 启用,其它禁止。默认为站点默认值 24 * @apiParam {int} [docModule] 是否启用文档共享:1 启用,其它禁止。默认为站点默认值
@@ -101,3 +100,107 @@ @@ -101,3 +100,107 @@
101 </result> 100 </result>
102 * 101 *
103 */ 102 */
  103 +/**
  104 + * @api {post} /3m/meeting/join_mtg.do 02.获取课堂地址
  105 + * @apiName joinMtg
  106 + * @apiGroup meeting
  107 + * @apiVersion 2.1.0
  108 + * @apiDescription 获取课堂地址, ,如果课堂不存在,先创建该课堂
  109 + *
  110 + * @apiParam {String} siteId 站点标识
  111 + * @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64
  112 + * @apiParam {String} mtgTitle 课堂名称或者课堂主题,最大长度 32
  113 + * @apiParam {String} startTime 课堂的开始时间,作为课堂开始气泡提示的参考时间。格式为:YYYY-MM-DD HH:MM:SS
  114 + * @apiParam {String} endTime 课堂的结束时间,作为课堂结束气泡提示的参考时间。格式为:YYYY-MM-DD HH:MM:SS
  115 + * @apiParam {int} [duration] 持续时长
  116 + * @apiParam {int} [language=2] 客户端语言:1 英文, 2 中文
  117 + * @apiParam {String} userName 客户端显示的姓名,最大长度 32
  118 + * @apiParam {String} userId 英文或数字组成的字符串,最大长度 50。等于0时是匿名用户,可以允许多个用户同时存在
  119 + * @apiParam {int} userType 用户类型:1 主持人(所有权限) 2 主讲人(不能操作摄像头) 8 普通与会者 32 监课人员
  120 + * @apiParam {int} [meetingType=1] 1 互动 支持多人音视频,适用于小班授课 2 直播 适用于千人以上大课堂,不能进行音视频互动,支持H5网页观看
  121 + * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证
  122 + * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取
  123 + * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取
  124 + * @apiParam {String} sharedMediaID 媒体共享文件唯一标识。多个标识用英文逗号分隔。标识通过查询媒体共享文件接口获取
  125 + * @apiParam {String} [backUrl] 课堂结束后的回调地址
  126 + * @apiParam {Long} timestamp 时间戳
  127 + * @apiParam {int} [docModule] 是否启用文档共享:1 启用,其它禁止。默认为站点默认值
  128 + * @apiParam {int} [screenModule] 是否启用屏幕共享:1 启用,其它禁止。仅当站点开启屏幕共享时有效
  129 + * @apiParam {int} [mediaModule] 是否启用媒体共享:1 启用,其它禁止。仅当站点开启媒体共享时有效
  130 + * @apiParam {int} [whiteboardModule] 是否启用白板:1 启用,其它禁止
  131 + * @apiParam {int} [recordModule] 是否启用录制:1 启用,其它禁止。仅当站点开启录制功能时有效
  132 + * @apiParam {int} [videoModule] 是否启用视频:1 启用,其它禁止。仅当站点开启视频功能时有效
  133 + * @apiParam {int} [h5Module] 是否启用 H5:1 启用,其它禁止。仅当站点开启 H5 功能时有效
  134 + * @apiParam {int} [autoRecord] 是否自动录制:1 是 0 否。默认为站点默认值
  135 + * @apiParam {int} [interaction] 是否参与音视频互动:1 是 0 否。默认为站点默认值
  136 + * @apiParam {int} [maxAudioChannels] 最大音频路数。如果不传或传的值大于站点配置,以站点配置为准。直播课堂只支持 1 路
  137 + * @apiParam {int} [maxVideoChannels] 最大视频路数。如果不传或传的值大于站点配置,以站点配置为准。直播课堂只支持 1 路
  138 + * @apiParam {int} [videoQuality=0] 视频画质设置:0 低,1 中,2 高,3 较高,4 最高
  139 + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
  140 + *
  141 + * @apiSuccess {int} errorCode
  142 + * 0:正常 <br/>
  143 + * 1:siteId 错误,站点不存在或已删除 <br/>
  144 + * 2:站点未到生效日期 <br/>
  145 + * 3: 站点过期 <br/>
  146 + * 4:课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
  147 + * 5:用户信息 userName/userId/userType 不能为空 <br/>
  148 + * 6:timestamp 超时 <br/>
  149 + * 7:authId 错误 <br/>
  150 + * 8:authId 不能重复使用 <br/>
  151 + * 9:课堂开始或结束时间格式错误 <br/>
  152 + * 10:报文格式错误 <br/>
  153 + * @apiSuccess {String} url 课堂地址,GET请求
  154 + * @apiSuccess {String} param 已废弃
  155 + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
  156 + * @apiSuccess {String} password 课堂密码
  157 + * @apiSuccess {Long} timestamp 时间戳
  158 + *
  159 + * @apiParamExample {xml} 请求示例
  160 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  161 + &lt;param&gt;
  162 + &lt;siteId&gt;admin&lt;/siteId&gt;
  163 + &lt;timestamp&gt;1476174725597&lt;/timestamp&gt;
  164 + &lt;authId&gt;450d6357348e5c16a6ffb0069b9ae86f&lt;/authId&gt;
  165 + &lt;mtgKey&gt;100012&lt;/mtgKey&gt;
  166 + &lt;mtgTitle&gt;admintest&lt;/mtgTitle&gt;
  167 + &lt;startTime&gt;2016-08-12 14:00:00&lt;/startTime&gt;
  168 + &lt;endTime&gt;2017-08-12 14:30:00&lt;/endTime&gt;
  169 + &lt;language&gt;1&lt;/language&gt;
  170 + &lt;userName&gt;shanghai&lt;/userName&gt;
  171 + &lt;userId&gt;2000012&lt;/userId&gt;
  172 + &lt;userType&gt;8&lt;/userType&gt;
  173 + &lt;hostPwd&gt;123456&lt;/hostPwd&gt;
  174 + &lt;meetingType&gt;1&lt;/meetingType&gt;
  175 + &lt;isPublic&gt;1&lt;/isPublic&gt;
  176 + &lt;docModule&gt;0&lt;/docModule&gt;
  177 + &lt;screenModule&gt;0&lt;/screenModule&gt;
  178 + &lt;mediaModule&gt;0&lt;/mediaModule&gt;
  179 + &lt;whiteboardModule&gt;0&lt;/whiteboardModule&gt;
  180 + &lt;recordModule&gt;0&lt;/recordModule&gt;
  181 + &lt;videoModule&gt;0&lt;/videoModule&gt;
  182 + &lt;h5Module&gt;0&lt;/h5Module&gt;
  183 + &lt;autoRecord&gt;0&lt;/autoRecord&gt;
  184 + &lt;interaction&gt;0&lt;/interaction&gt;
  185 + &lt;maxAudioChannels&gt;1&lt;/maxAudioChannels&gt;
  186 + &lt;maxVideoChannels&gt;1&lt;/maxVideoChannels&gt;
  187 + &lt;videoQuality&gt;1&lt;/videoQuality&gt;
  188 + &lt;docID&gt;1,2,3&lt;/docID&gt;
  189 + &lt;mediaID&gt;3,2,1&lt;/mediaID&gt;
  190 + &lt;sharedMediaID&gt;3,2,1&lt;/sharedMediaID&gt;
  191 + &lt;backUrl&gt;&lt;/backUrl&gt;
  192 + &lt;videoQuality&gt;0&lt;/videoQuality&gt;
  193 + &lt;/param&gt;
  194 + *
  195 + * @apiSuccessExample {xml} 返回示例
  196 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  197 + &lt;result&gt;
  198 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  199 + &lt;url&gt;http://localhost/h5/index.html?portalPort=8080&amp;portalIP=127.0.0.1&amp;classId=1992106612&amp;userId=2000012&amp;channels=1&amp;userName=%E5%BC%A0%E4%B8%89&amp;m=84b79056d155e186052dcf53cd22d54b&amp;userRole=normal&lt;/url&gt;
  200 + &lt;param&gt;&lt;/param&gt;
  201 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  202 + &lt;meetingNumber&gt;01234567&lt;/meetingNumber&gt;
  203 + &lt;password&gt;1234&lt;/password&gt;
  204 + &lt;/result&gt;
  205 + *
  206 + */