lipengjava

timestamp.do

  1 +doc/
  2 +api-doc.iml
  1 +{
  2 + "name":"接口文档",
  3 + "version":"1.6.0",
  4 + "description":"学点云对外接口文档"
  5 +}
  1 +/**
  2 + * @api {POST} /3m/meeting/join_mtg.do 获取 PC 端课堂地址
  3 + * @apiName getTimestamp
  4 + * @apiGroup meeting
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 获取 PC 端课堂地址, 如果课堂不存在,先创建该课堂
  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 {String} authId MD5(key+siteId+random), 其中 key 为不系统约定的加密 key,也就是站点生成的key
  19 + *
  20 + * @apiSuccess {int} errorCode
  21 + * 0:各参数都正确 <br/>
  22 + * 1:siteId 错误 <br/>
  23 + * 2:站点未到生效日期 <br/>
  24 + * 3: 站点过期 <br/>
  25 + * 4:authId 错误 <br/>
  26 + * 10:报文格式错误 <br/>
  27 + * @apiSuccess {Long} random 传入的random
  28 + * @apiSuccess {Long} timestamp 时间戳
  29 + *
  30 + * @apiParamExample {xml} 请求示例
  31 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  32 + &lt;param&gt;
  33 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  34 + &lt;random&gt;1293230129&lt;/random&gt;
  35 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  36 + &lt;/param&gt;
  37 + *
  38 + * @apiSuccessExample {xml} 返回示例
  39 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  40 + &lt;result&gt;
  41 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  42 + &lt;random&gt;1293230129&lt;/random&gt;
  43 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  44 + &lt;/result&gt;
  45 + *
  46 + */