正在显示
1 个修改的文件
包含
104 行增加
和
1 行删除
| @@ -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 | + <?xml version="1.0" encoding="UTF-8"?> | ||
| 161 | + <param> | ||
| 162 | + <siteId>admin</siteId> | ||
| 163 | + <timestamp>1476174725597</timestamp> | ||
| 164 | + <authId>450d6357348e5c16a6ffb0069b9ae86f</authId> | ||
| 165 | + <mtgKey>100012</mtgKey> | ||
| 166 | + <mtgTitle>admintest</mtgTitle> | ||
| 167 | + <startTime>2016-08-12 14:00:00</startTime> | ||
| 168 | + <endTime>2017-08-12 14:30:00</endTime> | ||
| 169 | + <language>1</language> | ||
| 170 | + <userName>shanghai</userName> | ||
| 171 | + <userId>2000012</userId> | ||
| 172 | + <userType>8</userType> | ||
| 173 | + <hostPwd>123456</hostPwd> | ||
| 174 | + <meetingType>1</meetingType> | ||
| 175 | + <isPublic>1</isPublic> | ||
| 176 | + <docModule>0</docModule> | ||
| 177 | + <screenModule>0</screenModule> | ||
| 178 | + <mediaModule>0</mediaModule> | ||
| 179 | + <whiteboardModule>0</whiteboardModule> | ||
| 180 | + <recordModule>0</recordModule> | ||
| 181 | + <videoModule>0</videoModule> | ||
| 182 | + <h5Module>0</h5Module> | ||
| 183 | + <autoRecord>0</autoRecord> | ||
| 184 | + <interaction>0</interaction> | ||
| 185 | + <maxAudioChannels>1</maxAudioChannels> | ||
| 186 | + <maxVideoChannels>1</maxVideoChannels> | ||
| 187 | + <videoQuality>1</videoQuality> | ||
| 188 | + <docID>1,2,3</docID> | ||
| 189 | + <mediaID>3,2,1</mediaID> | ||
| 190 | + <sharedMediaID>3,2,1</sharedMediaID> | ||
| 191 | + <backUrl></backUrl> | ||
| 192 | + <videoQuality>0</videoQuality> | ||
| 193 | + </param> | ||
| 194 | + * | ||
| 195 | + * @apiSuccessExample {xml} 返回示例 | ||
| 196 | + <?xml version="1.0" encoding="UTF-8"?> | ||
| 197 | + <result> | ||
| 198 | + <errorCode>0</errorCode> | ||
| 199 | + <url>http://localhost/h5/index.html?portalPort=8080&portalIP=127.0.0.1&classId=1992106612&userId=2000012&channels=1&userName=%E5%BC%A0%E4%B8%89&m=84b79056d155e186052dcf53cd22d54b&userRole=normal</url> | ||
| 200 | + <param></param> | ||
| 201 | + <timestamp>1392032123210</timestamp> | ||
| 202 | + <meetingNumber>01234567</meetingNumber> | ||
| 203 | + <password>1234</password> | ||
| 204 | + </result> | ||
| 205 | + * | ||
| 206 | + */ |
-
请 注册 或 登录 后发表评论