lipengjava

join_mtg

  1 +/**
  2 + * @api {post} /3m/meeting/join_mtg.do 获取课堂地址
  3 + * @apiName joinMtg
  4 + * @apiGroup meeting
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 获取课堂地址, ,如果课堂不存在,先创建该课堂
  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} duration 持续时长。可选
  14 + * @apiParam {int} language 客户端语言:1 英文, 2 中文。默认为 2
  15 + * @apiParam {String} userName 客户端显示的姓名,最大长度 32
  16 + * @apiParam {String} userId 英文或数字组成的字符串,最大长度 50。等于0时是匿名用户,可以允许多个用户同时存在
  17 + * @apiParam {int} userType 用户类型:1 主持人(所有权限) 2 主讲人(不能操作摄像头) 8 普通与会者 32 监课人员
  18 + * @apiParam {int} meetingType 1 互动 2 直播。默认为 1。<br/>
  19 + * 互动课堂支持多人音视频,适用于小班授课;直播课堂适用于千人以上大课堂,不能进行音视频互动,支持H5网页观看
  20 + * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证
  21 + * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取
  22 + * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取
  23 + * @apiParam {String} backUrl 课堂结束后的回调地址。可选
  24 + * @apiParam {Long} timestamp 时间戳
  25 + * @apiParam {int} docModule 是否启用文档共享:1 启用,其它禁止。可选,默认为站点默认值
  26 + * @apiParam {int} screenModule 是否启用屏幕共享:1 启用,其它禁止。仅当站点开启屏幕共享时有效。可选
  27 + * @apiParam {int} mediaModule 是否启用媒体共享:1 启用,其它禁止。仅当站点开启媒体共享时有效。可选
  28 + * @apiParam {int} whiteboardModule 是否启用白板:1 启用,其它禁止。可选
  29 + * @apiParam {int} recordModule 是否启用录制:1 启用,其它禁止。仅当站点开启录制功能时有效。可选
  30 + * @apiParam {int} videoModule 是否启用视频:1 启用,其它禁止。仅当站点开启视频功能时有效。可选
  31 + * @apiParam {int} h5Module 是否启用 H5:1 启用,其它禁止。仅当站点开启 H5 功能时有效。可选
  32 + * @apiParam {int} autoRecord 是否自动录制:1 是 0 否。可选,默认为站点默认值
  33 + * @apiParam {int} interaction 是否参与音视频互动:1 是 0 否。可选,默认为站点默认值
  34 + * @apiParam {int} maxAudioChannels 最大音频路数。可选,如果不传或传的值大于站点配置,以站点配置为准。直播课堂只支持 1 路
  35 + * @apiParam {int} maxVideoChannels 最大视频路数。可选,如果不传或传的值大于站点配置,以站点配置为准。直播课堂只支持 1 路
  36 + * @apiParam {int} videoQuality 视频画质设置:0 低,1 中,2 高,3 较高,4 最高
  37 + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
  38 + *
  39 + * @apiSuccess {int} errorCode
  40 + * 0:正常 <br/>
  41 + * 1:siteId 错误,站点不存在或已删除 <br/>
  42 + * 2:站点未到生效日期 <br/>
  43 + * 3: 站点过期 <br/>
  44 + * 4:课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
  45 + * 5:用户信息 userName/userId/userType 不能为空 <br/>
  46 + * 6:timestamp 超时 <br/>
  47 + * 7:authId 错误 <br/>
  48 + * 8:authId 不能重复使用 <br/>
  49 + * 9:课堂开始或结束时间格式错误 <br/>
  50 + * 10:报文格式错误 <br/>
  51 + * @apiSuccess {String} url 课堂地址
  52 + * @apiSuccess {String} param 地址请求参数,post 请求,参数名是 param
  53 + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
  54 + * @apiSuccess {String} password 课堂密码
  55 + * @apiSuccess {Long} timestamp 时间戳
  56 + *
  57 + * @apiParamExample {xml} 请求示例
  58 + <?xml version="1.0" encoding="UTF-8"?>
  59 + <param>
  60 + <siteId>admin</siteId>
  61 + <timestamp>1476174725597</timestamp>
  62 + <authId>450d6357348e5c16a6ffb0069b9ae86f</authId>
  63 + <mtgKey>100012</mtgKey>
  64 + <mtgTitle>admintest</mtgTitle>
  65 + <startTime>2016-08-12 14:00:00</startTime>
  66 + <endTime>2017-08-12 14:30:00</endTime>
  67 + <language>1</language>
  68 + <userName>shanghai</userName>
  69 + <userId>2000012</userId>
  70 + <userType>8</userType>
  71 + <hostPwd>123456</hostPwd>
  72 + <meetingType>1</meetingType>
  73 + <isPublic>1</isPublic>
  74 + <docModule>0</docModule>
  75 + <screenModule>0</screenModule>
  76 + <mediaModule>0</mediaModule>
  77 + <whiteboardModule>0</whiteboardModule>
  78 + <recordModule>0</recordModule>
  79 + <videoModule>0</videoModule>
  80 + <h5Module>0</h5Module>
  81 + <autoRecord>0</autoRecord>
  82 + <interaction>0</interaction>
  83 + <maxAudioChannels>1</maxAudioChannels>
  84 + <maxVideoChannels>1</maxVideoChannels>
  85 + <videoQuality>1</videoQuality>
  86 + <docID>1,2,3</docID>
  87 + <mediaID>3,2,1</mediaID>
  88 + <backUrl></backUrl>
  89 + <videoQuality>0</videoQuality>
  90 + </param>
  91 + *
  92 + * @apiSuccessExample {xml} 返回示例
  93 + <?xml version="1.0" encoding="UTF-8"?>
  94 + <result>
  95 + <errorCode>0</errorCode>
  96 + <url>http://127.0.0.1:8080/3m/live/index.jsp</url>
  97 + <param>字符串</param>
  98 + <timestamp>1392032123210</timestamp>
  99 + <meetingNumber>01234567</meetingNumber>
  100 + <password>1234</password>
  101 + </result>
  102 + *
  103 + */
1 /** 1 /**
2 - * @api {POST} /3m/meeting/join_mtg.do 获取 PC 端课堂地址 2 + * @api {GET} /3m/meeting/timestamp.do 获取服务器时间戳
3 * @apiName getTimestamp 3 * @apiName getTimestamp
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
6 - * @apiDescription 获取 PC 端课堂地址, 如果课堂不存在,先创建该课堂 6 + * @apiDescription 获取服务器时间戳
7 * 7 *
8 * @apiParam {String} siteId 站点标识 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} duration 持续时长。 可选  
14 - * @apiParam {int} language 客户端语言:1 英文,2 中文。默认为2  
15 - * @apiParam {String} userName 客户端显示的姓名,最大长度32  
16 - * @apiParam {String} userId 英文或数字组成的字符串,最大长度50。等于0时为匿名用户,可以允许多个匿名用户同时存在  
17 - * @apiParam {int} userType 用户类型:1 主持人(所有权限) 2 主讲人(不能操作摄像头) 8 普通与会者 32 监课人员  
18 - * @apiParam {String} authId MD5(key+siteId+random), 其中 key 为不系统约定的加密 key,也就是站点生成的key 9 + * @apiParam {Long} random 随机整数
  10 + * @apiParam {String} authId MD5(key+siteId+random), 其中 key 为与系统约定的加密 key
19 * 11 *
20 * @apiSuccess {int} errorCode 12 * @apiSuccess {int} errorCode
21 * 0:各参数都正确 <br/> 13 * 0:各参数都正确 <br/>
@@ -24,7 +16,7 @@ @@ -24,7 +16,7 @@
24 * 3: 站点过期 <br/> 16 * 3: 站点过期 <br/>
25 * 4:authId 错误 <br/> 17 * 4:authId 错误 <br/>
26 * 10:报文格式错误 <br/> 18 * 10:报文格式错误 <br/>
27 - * @apiSuccess {Long} random 传入的random 19 + * @apiSuccess {Long} random 传入的 random
28 * @apiSuccess {Long} timestamp 时间戳 20 * @apiSuccess {Long} timestamp 时间戳
29 * 21 *
30 * @apiParamExample {xml} 请求示例 22 * @apiParamExample {xml} 请求示例