lipengjava

获取H5课堂地址接口。接口标题加序号

  1 +/**
  2 + * @api {post} /3m/meeting/join_class_h5_foreign.do 3.获取h5页面课堂地址
  3 + * @apiName joinClassH5
  4 + * @apiGroup meeting
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 获取h5页面课堂地址,如果课堂不存在,先创建该课堂
  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 {int} [meetingType=1] 1 互动 支持多人音视频,适用于小班授课 2 直播 适用于千人以上大课堂,不能进行音视频互动,支持H5网页观看
  18 + * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证
  19 + * @apiParam {String} docID 暂不支持
  20 + * @apiParam {String} mediaID 暂不支持
  21 + * @apiParam {String} [backUrl] 暂不支持
  22 + * @apiParam {Long} timestamp 时间戳
  23 + * @apiParam {int} [h5Module] 是否启用 H5:1 启用,其它禁止。仅当站点开启 H5 功能时有效
  24 + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
  25 + *
  26 + * @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/>;
  38 + * 11: 该课堂没有开启h5
  39 + * @apiSuccess {String} url 课堂地址
  40 + * @apiSuccess {String} param
  41 + * @apiSuccess {String} siteId
  42 + * @apiSuccess {String} classID 课堂 id
  43 + * @apiSuccess {String} userName
  44 + * @apiSuccess {String} userId
  45 + * @apiSuccess {String} userType
  46 + * @apiSuccess {String} nopassword 是否需要验证密码 False:不需要验证 True: 需要验证
  47 + * @apiSuccess {String} portalIP 服务器ip
  48 + * @apiSuccess {String} portalPort 服务器端口
  49 + * @apiSuccess {String} md5 返回的md5
  50 + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
  51 + * @apiSuccess {Long} timestamp 时间戳
  52 + *
  53 + * @apiParamExample {xml} 请求示例
  54 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  55 + &lt;param&gt;
  56 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  57 + &lt;mtgKey&gt;100012&lt;/mtgKey&gt;
  58 + &lt;mtgTitle&gt;shanghai&lt;/mtgTitle&gt;
  59 + &lt;startTime&gt;2015-08-12 14:00:00&lt;/startTime&gt;
  60 + &lt;endTime&gt;2015-08-12 14:30:00&lt;/endTime&gt;
  61 + &lt;language&gt;1&lt;/language&gt;
  62 + &lt;userName&gt;shanghai&lt;/userName&gt;
  63 + &lt;userId&gt;2000012&lt;/userId&gt;
  64 + &lt;userType&gt;8&lt;/userType&gt;
  65 + &lt;meetingType&gt;1&lt;/meetingType&gt;
  66 + &lt;h5Module&gt;1&lt;/h5Module&gt;
  67 + &lt;hostPwd&gt;123456&lt;/hostPwd&gt;
  68 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  69 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  70 + &lt;/param&gt;
  71 + *
  72 + * @apiSuccessExample {xml} 返回示例
  73 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  74 + &lt;result&gt;
  75 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  76 + &lt;url&gt;http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp&lt;/url&gt;
  77 + &lt;param&gt;
  78 + &lt;siteId&gt;admin&lt;/siteId&gt;
  79 + &lt;classID&gt;1419338704&lt;/classID&gt;
  80 + &lt;userName&gt;shanghai&lt;/userName&gt;
  81 + &lt;userId&gt;2000012&lt;/userId&gt;
  82 + &lt;nopassword&gt;false&lt;/nopassword&gt;
  83 + &lt;userType&gt;8&lt;/userType&gt;
  84 + &lt;portalIP&gt;127.0.0.1&lt;/portalIP&gt;
  85 + &lt;portalPort&gt;8080&lt;/portalPort&gt;
  86 + &lt;md5&gt;790a9c17892e99c89d6bef2cb1b5d2e6&lt;/md5&gt;
  87 + &lt;/param&gt;
  88 + &lt;timestamp&gt;1447815907543&lt;/timestamp&gt;
  89 + &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt;
  90 + &lt;/result&gt;
  91 + * 得到地址拼接跳转:http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&userName=shanghai&userId=11111&userType=8&nopassword=false&classID=2043575585&portalIP=127.0.0.1&portalPort=8080&md5= 86e2b69e2919fb9592025f37f84f5066
  92 + */
  93 +
  94 +/**
  95 + * @api {post} /3m/meeting/join_class_h5_foreign.do 3.获取h5页面课堂地址
  96 + * @apiName joinClassH5
  97 + * @apiGroup meeting
  98 + * @apiVersion 2.0.0
  99 + * @apiDeprecated 请使用 /3m/meeting/join_mtg.do
  100 + * @apiDescription 获取h5页面课堂地址
  101 + */