apidoc.php 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403
  1. <?php
  2. /**
  3. * @api {get} common.public 公共参数说明
  4. * @apiVersion 1.0.0
  5. * @apiName common.public
  6. * @apiGroup Common
  7. *
  8. * @apiDescription 介绍公共参数
  9. *
  10. * @apiParam {Number} json 是否返回json格式的数据1为返回2为不返回
  11. * @apiParam {Number} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  12. * @apiParam {Number} pg 分页数,第几页,列表页瀑布流使用该参数
  13. *
  14. * @apiSuccess {Number} status 状态,1为有效2为无效
  15. * @apiSuccess {String} msg 请求的数据是否成功的提示
  16. * @apiSuccess {String} data 如果status为1,data有值
  17. * @apiSuccess {Object[]} page 分页信息
  18. * @apiSuccess {Number} page.total 分页总数
  19. * @apiSuccess {Number} page.current_page 当前页
  20. * @apiSuccess {Number} page.total_page 总页数
  21. * @apiSuccess {Number} page.next_page 下一页
  22. * @apiSuccess {Number} page.prev_page 上一页
  23. * @apiSuccess {Number} page.status 是否有下一页数据,0为没有
  24. */
  25. /**
  26. * @api {get} common.type 类型设置说明
  27. * @apiVersion 1.0.0
  28. * @apiName common.type
  29. * @apiGroup Common
  30. *
  31. * @apiDescription 类型设置说明
  32. *
  33. * @apiParam {String} source_type 请在header中定义,ios:ios | android:android | 移动h5:h5 | 小程序:applet | 公众号:service | pc网站:pc
  34. * @apiParam {Number} type 图文:1 | 视频:2 | 直播:3 | 小刊:4 | 小刊音视频:5 | 专题:6 | 小程序:7 | 商品:8 | 链接:10 | 评论: 11 || 直播评论:12 | 小刊活动页:13
  35. * @apiParam {Number} push_ 所有带push_开头的返回参数,返回字典都是一样的,参考获取首页数据中的push_focus
  36. */
  37. /**
  38. * @api {post} upload/upload/?save.start 上传图片接口
  39. * @apiVersion 1.0.0
  40. * @apiName save.start
  41. * @apiGroup Common
  42. *
  43. * @apiParam {Number} key 值为6,写死即可
  44. * @apiParam {String} file 文件流 multipart/form-data形式
  45. *
  46. * @apiSuccess {String} url 图片地址
  47. */
  48. /**
  49. * @api {get} wonderful/passport/?l=applet.bind 用户登录
  50. * @apiVersion 1.0.0
  51. * @apiName applet.bind
  52. * @apiGroup AppletPassport
  53. *
  54. * @apiDescription 用户登录
  55. *
  56. * @apiParam {String} code 微信登录返回的code
  57. *
  58. * @apiSuccess {Number} vid 微信id,请保存在本地
  59. * @apiSuccess {Number} uid 用户id,请保存在本地
  60. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  61. */
  62. /**
  63. * @api {get} wonderful/passport/?l=applet.update 更新用户信息
  64. * @apiVersion 1.0.0
  65. * @apiName applet.update
  66. * @apiGroup AppletPassport
  67. *
  68. * @apiDescription 更新用户信息
  69. *
  70. * @apiParam {String} nickname 用户昵称
  71. * @apiParam {String} avatarurl 用户头像
  72. * @apiParam {String} gender 性别
  73. * @apiParam {String} city 城市
  74. * @apiParam {String} province 省份
  75. * @apiParam {String} country 县区
  76. * @apiParam {String} iv 微信的加密参数
  77. * @apiParam {String} encryptedData 微信的加密参数
  78. * @apiParam {Number} vid 微信id
  79. * @apiParam {Number} uid 用户id
  80. * @apiParam {String} signature signature
  81. *
  82. *
  83. * @apiSuccess {Number} vid 微信id,请保存在本地
  84. * @apiSuccess {Number} uid 用户id,请保存在本地
  85. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  86. */
  87. /**
  88. * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
  89. * @apiVersion 1.0.0
  90. * @apiName applet.mobile
  91. * @apiGroup AppletPassport
  92. *
  93. * @apiDescription 更新用户手机号-微信绑定
  94. *
  95. * @apiParam {String} iv 微信的加密参数
  96. * @apiParam {String} encryptedData 微信的加密参数
  97. * @apiParam {Number} vid 微信id
  98. * @apiParam {Number} uid 用户id
  99. * @apiParam {String} signature signature
  100. *
  101. *
  102. * @apiSuccess {Number} vid 微信id,请保存在本地
  103. * @apiSuccess {Number} uid 用户id,请保存在本地
  104. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  105. */
  106. /**
  107. * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  108. * @apiVersion 1.0.0
  109. * @apiName applet.bind_mobile
  110. * @apiGroup AppletPassport
  111. *
  112. * @apiDescription 更新用户手机号-验证码绑定
  113. *
  114. * @apiParam {Number} uid 用户id
  115. * @apiParam {Number} mobile 手机号
  116. * @apiParam {String} mcode 验证码
  117. * @apiParam {String} signature signature
  118. *
  119. * @apiSuccess {Number} uid 用户id,请保存在本地
  120. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  121. */
  122. /**
  123. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
  124. * @apiVersion 1.0.0
  125. * @apiName reg.getMCode
  126. * @apiGroup AppletPassport
  127. *
  128. * @apiDescription 获取手机验证码
  129. *
  130. * @apiParam {Number} mobile 手机号
  131. *
  132. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  133. */
  134. /**
  135. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码,未登录状态
  136. * @apiVersion 1.0.0
  137. * @apiName reg.getMCode
  138. * @apiGroup AppPassport
  139. *
  140. * @apiDescription 获取手机验证码,未登录状态
  141. *
  142. * @apiParam {Number} mobile 手机号
  143. *
  144. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  145. */
  146. /**
  147. * @api {get} wonderful/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
  148. * @apiVersion 1.0.0
  149. * @apiName reg.getMCode
  150. * @apiGroup AppPassport
  151. *
  152. * @apiDescription 获取手机验证码,已登录状态
  153. *
  154. * @apiParam {Number} mobile 手机号
  155. * @apiParam {String} signature signature
  156. *
  157. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  158. */
  159. /**
  160. * @api {get} wonderful/passport/?l=app.login 登录与注册
  161. * @apiVersion 1.0.0
  162. * @apiName app.login
  163. * @apiGroup AppPassport
  164. *
  165. * @apiDescription 登录与注册
  166. *
  167. * @apiParam {Number} mobile 手机号
  168. * @apiParam {String} mcode 验证码
  169. *
  170. * @apiSuccess {Number} uid 用户id,请保存在本地
  171. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  172. */
  173. /**
  174. * @api {get} wonderful/passport/?l=app.bind_mobile 更新用户手机号-验证码绑定
  175. * @apiVersion 1.0.0
  176. * @apiName app.bind_mobile
  177. * @apiGroup AppPassport
  178. *
  179. * @apiDescription 更新用户手机号-验证码绑定
  180. *
  181. * @apiParam {Number} uid 用户id
  182. * @apiParam {Number} mobile 手机号
  183. * @apiParam {String} mcode 验证码
  184. * @apiParam {String} signature signature
  185. *
  186. * @apiSuccess {Number} uid 用户id,请保存在本地
  187. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  188. */
  189. /**
  190. * @api {get} wonderful/passport/?l=app.wechat_reg 第三方登录-已经拥有openid
  191. * @apiVersion 1.0.0
  192. * @apiName app.wechat_reg
  193. * @apiGroup AppPassport
  194. *
  195. * @apiDescription 第三方登录-已经拥有openid
  196. *
  197. * @apiParam {String} username 用户名
  198. * @apiParam {String} avatar 头像
  199. * @apiParam {String} sex 性别
  200. * @apiParam {String} city 城市
  201. * @apiParam {String} province 省份
  202. * @apiParam {String} country 县区
  203. * @apiParam {String} openid openid
  204. * @apiParam {String} unionid unionid
  205. * @apiParam {String} access_token access_token
  206. * @apiParam {String} refresh_token refresh_token
  207. * @apiParam {String} expires_in 失效时间
  208. *
  209. * @apiSuccess {Number} uid 用户id,请保存在本地
  210. * @apiSuccess {Number} mobile 手机号,判断手机号是否存在,不存在则需要进行绑定,请直接使用app.bind_mobile接口进行绑定即可
  211. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  212. */
  213. /**
  214. * @api {get} wonderful/oauth/?l=request.callback 第三方登录
  215. * @apiVersion 1.0.0
  216. * @apiName request.callback
  217. * @apiGroup AppPassport
  218. *
  219. * @apiDescription 第三方登录
  220. *
  221. * @apiParam {Number} account 第三方登录的账号,写死为2吧
  222. * @apiParam {Number} system 系统id,写死为1,后续做ok精彩和精品时再加
  223. * @apiParam {String} source 渠道来源,写死为1,默认1则为官网渠道
  224. * @apiParam {String} source_type 渠道类型,写死为ios或者android
  225. * @apiParam {String} code 用户授权后返回的code
  226. *
  227. * @apiSuccess {Number} uid 用户id,请保存在本地
  228. * @apiSuccess {Number} mobile 手机号,判断手机号是否存在,不存在则需要进行绑定,请直接使用app.bind_mobile接口进行绑定即可
  229. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  230. */
  231. /**
  232. * @api {get} wonderful/passport/?l=app.update 更新用户信息
  233. * @apiVersion 1.0.0
  234. * @apiName app.update
  235. * @apiGroup AppPassport
  236. *
  237. * @apiDescription 更新用户信息
  238. *
  239. * @apiParam {Number} signature 用户signature
  240. * @apiParam {String} username 用户昵称
  241. * @apiParam {String} avatar 用户头像
  242. * @apiParam {String} gender 性别
  243. * @apiParam {String} city 城市
  244. * @apiParam {String} province 省份
  245. * @apiParam {String} country 县区
  246. *
  247. * @apiSuccess {Number} uid 用户id,请保存在本地
  248. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  249. */
  250. /**
  251. * @api {get} wonderful/main/?l=view.getHtml 获取富文本内容
  252. * @apiVersion 1.0.0
  253. * @apiName view.getHtml
  254. * @apiGroup App
  255. *
  256. * @apiDescription 获取富文本内容
  257. *
  258. * @apiParam {Number} signature 用户signature
  259. * @apiParam {String} type 类型1为图文、2为视频、3为直播、4为小刊内容,6为专题
  260. * @apiParam {String} id 图文等内容id,如果为4,则为小刊的内容id,而非小刊id
  261. *
  262. * @apiSuccess {String} html 直接返回html的信息,请注意里面的协议:jstyle://live_note?id=0&live_id=1&file=test
  263. 其中有几个:
  264. jstyle://video?id=0&vod_id=1&file=test 播放视频 id=0为content_array里的数组索引,vod_id为视频id,file为视频文件地址
  265. jstyle://live?id=0&live_id=1&file=test 播放直播 id=0为content_array里的数组索引,live_id为直播id,file为直播文件地址
  266. jstyle://live_note?id=0&live_id=1&file=test&note=1 设置直播提醒 id=0为content_array里的数组索引,live_id为直播id,file为直播文件地址,note值为1是已设置提醒,2为未设置提醒
  267. jstyle://auido?id=0&file=test&note=1 播放视频 id=0为content_array里的数组索引,file为直播文件地址
  268. */
  269. /**
  270. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  271. * @apiVersion 1.0.0
  272. * @apiName api.get
  273. * @apiGroup Live
  274. *
  275. * @apiDescription 获取直播推流信息
  276. *
  277. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  278. *
  279. * @apiSuccess {Object[]} active 直播活动列表
  280. * @apiSuccess {String} active.id 活动id
  281. * @apiSuccess {String} acitve.name 活动名称
  282. * @apiSuccess {Object[]} active.stream 直播流列表
  283. * @apiSuccess {String} active.stream.id 推流id
  284. * @apiSuccess {String} active.stream.live 推流实际地址
  285. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  286. * @apiSuccess {String} active.stream.url_hls 播放地址
  287. * @apiSuccess {String} active.stream.url_hdl 播放地址
  288. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  289. */
  290. /**
  291. * @api {get} wonderful/live/?l=api.start 开始推流
  292. * @apiVersion 1.0.0
  293. * @apiName api.start
  294. * @apiGroup Live
  295. *
  296. * @apiDescription 开始推流
  297. *
  298. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  299. * @apiParam {Number} id 推流id
  300. *
  301. * @apiSuccess {Number} id 推流id
  302. * @apiSuccess {Number} log_id 本次推流日志id
  303. */
  304. /**
  305. * @api {get} wonderful/live/?l=api.stop 结束推流
  306. * @apiVersion 1.0.0
  307. * @apiName api.stop
  308. * @apiGroup Live
  309. *
  310. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  311. *
  312. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  313. * @apiParam {Number} id 推流id
  314. * @apiParam {Number} log_id 本次推流日志id
  315. */
  316. /**
  317. * @api {get} wonderful/main/?l=content.home 获取首页数据
  318. * @apiVersion 1.0.0
  319. * @apiName content.home
  320. * @apiGroup Content
  321. *
  322. * @apiDescription 获取首页数据
  323. *
  324. * @apiParam {String} signature signature
  325. *
  326. *
  327. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  328. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  329. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  330. * @apiSuccess {String} config.info 系统介绍
  331. * @apiSuccess {String} config.logo 系统logo
  332. * @apiSuccess {String} config.article_share_name 图文详情页分享文字
  333. * @apiSuccess {String} config.vod_share_name 视频详情页分享文字
  334. * @apiSuccess {String} config.live_share_name 直播详情页分享文字
  335. * @apiSuccess {String} config.ios_pay ios支付设置 1为不开启小程序支付,将所有购买按钮都隐藏掉,2为开启公众号支付,3开始小程序支付
  336. * @apiSuccess {String} config.ios_pay_pic ios里公众号支付引导图
  337. * @apiSuccess {Object[]} menu 栏目
  338. * @apiSuccess {String} menu.name 名称
  339. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  340. * @apiSuccess {Object[]} push_focus 焦点图
  341. * @apiSuccess {String} push_focus.name 名称
  342. * @apiSuccess {String} push_focus.cate_name 栏目名称
  343. * @apiSuccess {String} push_focus.author_name 作者名称
  344. * @apiSuccess {String} push_focus.pic 图片
  345. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  346. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  347. * @apiSuccess {String} push_focus.appid 当type==7时有效,小程序的appid
  348. * @apiSuccess {String} push_focus.link 当type==10或者type==7时有效,链接,如果type==7并且链接存在,则跳转到链接
  349. * @apiSuccess {String} push_focus.cdate 时间
  350. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  351. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  352. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  353. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  354. * @apiSuccess {Object[]} news 更多图文等数据
  355. * @apiSuccess {String} news.id 图文id
  356. * @apiSuccess {String} news.name 名称
  357. * @apiSuccess {String} news.pic_cover 4:3图片
  358. * @apiSuccess {String} news.pic_cover_169 16:9图片
  359. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  360. * @apiSuccess {String} news.pdate 时间
  361. * @apiSuccess {String} news.num_view 浏览量
  362. * @apiSuccess {String} news.num_up 喜欢量
  363. * @apiSuccess {String} news.num_comment 评论量
  364. * @apiSuccess {String} news.num_ding 订阅量
  365. * @apiSuccess {String} news.num_user 在线人数
  366. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  367. * @apiSuccess {String} news.share_title 分享标题
  368. * @apiSuccess {String} news.share_pic 分享图片
  369. * @apiSuccess {String} news.share_content 分享内容
  370. */
  371. /**
  372. * @api {get} wonderful/main/?l=content.ad 开屏广告接口
  373. * @apiVersion 1.0.0
  374. * @apiName content.ad
  375. * @apiGroup Content
  376. *
  377. * @apiDescription 开屏广告接口
  378. *
  379. * @apiParam {String} signature signature
  380. *
  381. *
  382. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  383. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  384. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  385. * @apiSuccess {String} config.info 系统介绍
  386. * @apiSuccess {String} config.logo 系统logo
  387. * @apiSuccess {String} config.article_share_name 图文详情页分享文字
  388. * @apiSuccess {String} config.vod_share_name 视频详情页分享文字
  389. * @apiSuccess {String} config.live_share_name 直播详情页分享文字
  390. * @apiSuccess {String} config.ios_pay ios支付设置 1为不开启小程序支付,将所有购买按钮都隐藏掉,2为开启公众号支付,3开始小程序支付
  391. * @apiSuccess {String} config.ios_pay_pic ios里公众号支付引导图
  392. * @apiSuccess {Object[]} push_screen_ad 广告
  393. * @apiSuccess {String} push_screen_ad.name 名称
  394. * @apiSuccess {String} push_screen_ad.pic 图片
  395. */
  396. /**
  397. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  398. * @apiVersion 1.0.0
  399. * @apiName content.up
  400. * @apiGroup Content
  401. *
  402. * @apiDescription 精选推荐更多
  403. *
  404. * @apiParam {String} signature signature
  405. *
  406. *
  407. * @apiSuccess {Object[]} push_up 栏目,字段同上
  408. * @apiSuccess {String} push_up.name 名称
  409. * @apiSuccess {String} push_up.pic 图片
  410. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  411. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  412. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  413. * @apiSuccess {String} push_up.cdate 时间
  414. */
  415. /**
  416. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  417. * @apiVersion 1.0.0
  418. * @apiName content.news
  419. * @apiGroup Content
  420. *
  421. * @apiDescription 精选页图文内容下拉更多
  422. *
  423. * @apiParam {String} signature signature
  424. * @apiParam {Number} menu 可选参数,栏目id
  425. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  426. *
  427. * @apiSuccess {Object[]} news 更多图文等数据
  428. * @apiSuccess {String} news.id 图文id
  429. * @apiSuccess {String} news.name 名称
  430. * @apiSuccess {String} news.pic_cover 4:3图片
  431. * @apiSuccess {String} news.pic_cover_169 16:9图片
  432. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  433. * @apiSuccess {String} news.pdate 时间
  434. * @apiSuccess {String} news.num_view 浏览量
  435. * @apiSuccess {String} news.num_up 喜欢量
  436. * @apiSuccess {String} news.num_comment 评论量
  437. * @apiSuccess {String} news.num_ding 订阅量
  438. * @apiSuccess {String} news.num_user 在线人数
  439. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  440. * @apiSuccess {String} news.share_title 分享标题
  441. * @apiSuccess {String} news.share_pic 分享图片
  442. * @apiSuccess {String} news.share_content 分享内容
  443. */
  444. /**
  445. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  446. * @apiVersion 1.0.0
  447. * @apiName view.comment
  448. * @apiGroup Content
  449. *
  450. * @apiDescription 查看评论列表
  451. *
  452. * @apiParam {String} signature signature
  453. * @apiParam {Number} id 图文id
  454. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  455. *
  456. * @apiSuccess {Object[]} comment 评论列表
  457. * @apiSuccess {String} comment.id
  458. * @apiSuccess {String} comment.username 用户名
  459. * @apiSuccess {String} comment.avatar 头像
  460. * @apiSuccess {String} comment.content 内容
  461. * @apiSuccess {String} comment.num_up 点赞数
  462. * @apiSuccess {String} comment.time 时间,请用这个时间吧
  463. * @apiSuccess {String} comment.cdate 时间
  464. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  465. * @apiSuccess {String} live_status 当type=3时,有该字段,直播状态,1为直播中,2为已结束,请根据该状态判断当前观看直播的用户是否能观看直播
  466. */
  467. /**
  468. * @api {get} wonderful/main/?l=view.article 查看图文内容
  469. * @apiVersion 1.0.0
  470. * @apiName view.article
  471. * @apiGroup Content
  472. *
  473. * @apiDescription 查看图文内容
  474. *
  475. * @apiParam {String} signature signature
  476. * @apiParam {Number} id 图文id
  477. *
  478. * @apiSuccess {Object[]} info 图文数据
  479. * @apiSuccess {String} info.id
  480. * @apiSuccess {String} info.name 名称
  481. * @apiSuccess {String} info.pic_cover 4:3图片
  482. * @apiSuccess {String} info.pic_cover_169 16:9图片
  483. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  484. * @apiSuccess {String} info.pdate 时间
  485. * @apiSuccess {String} info.cate_id 栏目ID
  486. * @apiSuccess {String} info.cate_name 栏目名称
  487. * @apiSuccess {String} info.author_id 作者ID
  488. * @apiSuccess {String} info.author_name 作者名称
  489. * @apiSuccess {String} info.num_view 浏览量
  490. * @apiSuccess {String} info.num_up 喜欢量
  491. * @apiSuccess {String} info.num_comment 评论量
  492. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  493. * @apiSuccess {String} info.share_title 分享标题
  494. * @apiSuccess {String} info.share_pic 分享图片
  495. * @apiSuccess {String} info.share_content 分享内容
  496. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  497. * @apiSuccess {String} info.content 内容
  498. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,当type为5时content为音频地址,name为标题,cover为封面、type为6时是视频地址,name为标题,cover为封面
  499. *
  500. * @apiSuccess {Object[]} comment 评论列表
  501. * @apiSuccess {String} comment.id
  502. * @apiSuccess {String} comment.username 用户名
  503. * @apiSuccess {String} comment.avatar 头像
  504. * @apiSuccess {String} comment.content 内容
  505. * @apiSuccess {String} comment.num_up 点赞数
  506. * @apiSuccess {String} comment.time 时间,请用这个时间
  507. * @apiSuccess {String} comment.cdate 时间
  508. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  509. *
  510. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  511. * @apiSuccess {String} user_act.share 用户分享数
  512. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  513. */
  514. /**
  515. * @api {get} wonderful/main/?l=view.feature 查看专题内容
  516. * @apiVersion 1.0.0
  517. * @apiName view.feature
  518. * @apiGroup Content
  519. *
  520. * @apiDescription 查看专题内容
  521. *
  522. * @apiParam {String} signature signature
  523. * @apiParam {Number} id 图文id
  524. *
  525. * @apiSuccess {Object[]} info 专题数据
  526. * @apiSuccess {String} info.id
  527. * @apiSuccess {String} info.name 名称
  528. * @apiSuccess {String} info.pic_cover 4:3图片
  529. * @apiSuccess {String} info.pic_cover_169 16:9图片
  530. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  531. * @apiSuccess {String} info.pdate 时间
  532. * @apiSuccess {String} info.cate_id 栏目ID
  533. * @apiSuccess {String} info.cate_name 栏目名称
  534. * @apiSuccess {String} info.author_id 作者ID
  535. * @apiSuccess {String} info.author_name 作者名称
  536. * @apiSuccess {String} info.num_view 浏览量
  537. * @apiSuccess {String} info.num_up 喜欢量
  538. * @apiSuccess {String} info.num_comment 评论量
  539. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  540. * @apiSuccess {String} info.share_title 分享标题
  541. * @apiSuccess {String} info.share_pic 分享图片
  542. * @apiSuccess {String} info.share_content 分享内容
  543. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  544. * @apiSuccess {String} info.content 内容
  545. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,当type为5时content为音频地址,name为标题,cover为封面、type为6时是视频地址,name为标题,cover为封面
  546. *
  547. * @apiSuccess {Object[]} comment 评论列表
  548. * @apiSuccess {String} comment.id
  549. * @apiSuccess {String} comment.username 用户名
  550. * @apiSuccess {String} comment.avatar 头像
  551. * @apiSuccess {String} comment.content 内容
  552. * @apiSuccess {String} comment.num_up 点赞数
  553. * @apiSuccess {String} comment.time 时间,请用这个时间
  554. * @apiSuccess {String} comment.cdate 时间
  555. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  556. *
  557. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  558. * @apiSuccess {String} user_act.share 用户分享数
  559. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  560. */
  561. /**
  562. * @api {get} wonderful/main/?l=view.version 查看最新版本
  563. * @apiVersion 1.0.0
  564. * @apiName view.version
  565. * @apiGroup Content
  566. *
  567. * @apiDescription 查看最新版本
  568. *
  569. * @apiParam {String} signature signature
  570. *
  571. * @apiSuccess {Object[]} version 版本数据
  572. * @apiSuccess {String} version.name 版本名
  573. * @apiSuccess {String} version.code 版本号
  574. * @apiSuccess {String} version.desc 版本描述
  575. * @apiSuccess {String} version.up 1为强制更新 2为不强制
  576. * @apiSuccess {String} version.link 下载链接
  577. */
  578. /**
  579. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  580. * @apiVersion 1.0.0
  581. * @apiName view.vod
  582. * @apiGroup Content
  583. *
  584. * @apiDescription 查看视频内容
  585. *
  586. * @apiParam {String} signature signature
  587. * @apiParam {Number} id 视频id
  588. *
  589. * @apiSuccess {Object[]} info 视频数据
  590. * @apiSuccess {String} info.id
  591. * @apiSuccess {String} info.name 名称
  592. * @apiSuccess {String} info.pic_cover 4:3图片
  593. * @apiSuccess {String} info.pic_cover_169 16:9图片
  594. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  595. * @apiSuccess {String} info.pdate 时间
  596. * @apiSuccess {String} info.cate_id 栏目ID
  597. * @apiSuccess {String} info.cate_name 栏目名称
  598. * @apiSuccess {String} info.author_id 作者ID
  599. * @apiSuccess {String} info.author_name 作者名称
  600. * @apiSuccess {String} info.num_view 浏览量
  601. * @apiSuccess {String} info.num_up 喜欢量
  602. * @apiSuccess {String} info.num_comment 评论量
  603. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  604. * @apiSuccess {String} info.share_title 分享标题
  605. * @apiSuccess {String} info.share_pic 分享图片
  606. * @apiSuccess {String} info.share_content 分享内容
  607. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  608. * @apiSuccess {String} info.content 内容
  609. *
  610. *
  611. * @apiSuccess {Object[]} comment 评论列表
  612. * @apiSuccess {String} comment.id
  613. * @apiSuccess {String} comment.username 用户名
  614. * @apiSuccess {String} comment.avatar 头像
  615. * @apiSuccess {String} comment.content 内容
  616. * @apiSuccess {String} comment.num_up 点赞数
  617. * @apiSuccess {String} comment.cdate 时间
  618. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  619. *
  620. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  621. * @apiSuccess {String} user_act.share 用户分享数
  622. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  623. */
  624. /**
  625. * @api {get} wonderful/main/?l=view.live 查看直播内容
  626. * @apiVersion 1.0.0
  627. * @apiName view.live
  628. * @apiGroup Content
  629. *
  630. * @apiDescription 查看直播内容
  631. *
  632. * @apiParam {String} signature signature
  633. * @apiParam {Number} id 视频id
  634. *
  635. * @apiSuccess {Object[]} info 直播数据
  636. * @apiSuccess {String} info.id
  637. * @apiSuccess {String} info.name 名称
  638. * @apiSuccess {String} info.pic_cover 4:3封面图片
  639. * @apiSuccess {String} info.pic_cover_169 16:9图片
  640. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  641. * @apiSuccess {String} info.pdate 时间
  642. * @apiSuccess {String} info.cate_id 栏目ID
  643. * @apiSuccess {String} info.cate_name 栏目名称
  644. * @apiSuccess {String} info.author_id 作者ID
  645. * @apiSuccess {String} info.author_name 作者名称
  646. * @apiSuccess {String} info.sdate_time 开始时间
  647. * @apiSuccess {String} info.edate_time 结束时间
  648. * @apiSuccess {String} info.num_user 在线人数
  649. * @apiSuccess {String} info.num_view 浏览量
  650. * @apiSuccess {String} info.num_up 喜欢量
  651. * @apiSuccess {String} info.num_comment 评论量
  652. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  653. * @apiSuccess {String} info.share_title 分享标题
  654. * @apiSuccess {String} info.share_pic 分享图片
  655. * @apiSuccess {String} info.share_content 分享内容
  656. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  657. * @apiSuccess {String} info.content 直播介绍
  658. * @apiSuccess {String} info.stream 直播推流地址
  659. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  660. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  661. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  662. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  663. * @apiSuccess {String} info.url 回放播放地址
  664. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  665. *
  666. *
  667. * @apiSuccess {Object[]} comment 评论列表
  668. * @apiSuccess {String} comment.id
  669. * @apiSuccess {String} comment.username 用户名
  670. * @apiSuccess {String} comment.avatar 头像
  671. * @apiSuccess {String} comment.content 内容
  672. * @apiSuccess {String} comment.num_up 点赞数
  673. * @apiSuccess {String} comment.time 时间,请用这个时间
  674. * @apiSuccess {String} comment.cdate 时间
  675. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  676. *
  677. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  678. * @apiSuccess {String} user_act.share 用户分享数
  679. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  680. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  681. */
  682. /**
  683. * @api {get} wonderful/main/?l=view.getPage 查看单页内容
  684. * @apiVersion 1.0.0
  685. * @apiName view.getPage
  686. * @apiGroup Content
  687. *
  688. * @apiDescription 查看单页内容
  689. *
  690. * @apiParam {String} signature signature
  691. * @apiParam {Number} key 单页key
  692. *
  693. * @apiSuccess {Object[]} info 单页数据
  694. * @apiSuccess {String} info.id
  695. * @apiSuccess {String} info.name 名称
  696. * @apiSuccess {String} info.content 内容
  697. */
  698. /**
  699. * @api {get} wonderful/main/?l=user.poster 获取海报
  700. * @apiVersion 1.0.0
  701. * @apiName user.poster
  702. * @apiGroup UserAction
  703. *
  704. * @apiDescription 获取海报
  705. *
  706. * @apiParam {String} signature signature
  707. * @apiParam {Number} type type类型
  708. * @apiParam {Number} id 当前的数据id
  709. * @apiParam {String} path 首页path路径
  710. *
  711. * @apiSuccess {String} img 海报图片
  712. */
  713. /**
  714. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  715. * @apiVersion 1.0.0
  716. * @apiName user.submit_up
  717. * @apiGroup UserAction
  718. *
  719. * @apiDescription 喜欢
  720. *
  721. * @apiParam {String} signature signature
  722. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  723. * @apiParam {Number} id 当前的数据id
  724. *
  725. * @apiSuccess {Number} id 当前的数据id
  726. */
  727. /**
  728. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  729. * @apiVersion 1.0.0
  730. * @apiName user.submit_note
  731. * @apiGroup UserAction
  732. *
  733. * @apiDescription 直播预约提醒
  734. *
  735. * @apiParam {String} signature signature
  736. * @apiParam {Number} type type类型
  737. * @apiParam {Number} id 当前的数据id
  738. *
  739. * @apiSuccess {Number} id 当前的数据id
  740. */
  741. /**
  742. * @api {get} wonderful/main/?l=user.submit_share 分享
  743. * @apiVersion 1.0.0
  744. * @apiName user.submit_share
  745. * @apiGroup UserAction
  746. *
  747. * @apiDescription 分享
  748. *
  749. * @apiParam {String} signature signature
  750. * @apiParam {Number} type type类型
  751. * @apiParam {Number} id 当前的数据id
  752. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,将这几个数据保存到本地,(这里不要发起分享回流接口的请求,请在用户授权用户信息或者授权手机号之后再发起分享回流的接口请求,发起请求之后,请从本地删除这几个数据),然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  753. *
  754. * @apiSuccess {Number} id 当前的数据id
  755. */
  756. /**
  757. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  758. * @apiVersion 1.0.0
  759. * @apiName user.submit_share_reflux
  760. * @apiGroup UserAction
  761. *
  762. * @apiDescription 分享回流
  763. *
  764. * @apiParam {String} signature signature
  765. * @apiParam {Number} type type类型 scene参数中的第二个值
  766. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  767. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  768. *
  769. * @apiSuccess {Number} id 当前的数据id
  770. */
  771. /**
  772. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  773. * @apiVersion 1.0.0
  774. * @apiName user.submit_comment
  775. * @apiGroup UserAction
  776. *
  777. * @apiDescription 提交评论
  778. *
  779. * @apiParam {String} signature signature
  780. * @apiParam {Number} type type类型
  781. * @apiParam {Number} id 当前的数据id
  782. * @apiParam {String} content 评论内容
  783. *
  784. * @apiSuccess {Number} id 当前的数据id
  785. */
  786. /**
  787. * @api {get} wonderful/main/?l=user.submit_feedback 提交反馈
  788. * @apiVersion 1.0.0
  789. * @apiName user.submit_feedback
  790. * @apiGroup UserAction
  791. *
  792. * @apiDescription 提交反馈
  793. *
  794. * @apiParam {String} signature signature
  795. * @apiParam {String} type_id 反馈类型 必填
  796. * @apiParam {String} contact 联系方式 必填
  797. * @apiParam {String} content 反馈内容 必填
  798. *
  799. * @apiSuccess {Number} id 当前的数据id
  800. */
  801. /**
  802. * @api {get} wonderful/main/?l=user.get_feedback_type 获取反馈类型
  803. * @apiVersion 1.0.0
  804. * @apiName user.get_feedback_type
  805. * @apiGroup UserAction
  806. *
  807. * @apiDescription 获取反馈类型
  808. *
  809. * @apiParam {String} signature signature
  810. *
  811. * @apiSuccess {Object} type 类型
  812. */
  813. /**
  814. * @api {get} wonderful/main/?l=journal.home 小刊首页
  815. * @apiVersion 1.0.0
  816. * @apiName journal.home
  817. * @apiGroup Journal
  818. *
  819. * @apiDescription 小刊首页
  820. *
  821. * @apiParam {String} signature signature
  822. * @apiParam {String} system 分类id
  823. *
  824. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  825. * @apiSuccess {String} journal.id 小刊id
  826. * @apiSuccess {String} journal.name 名称
  827. * @apiSuccess {String} journal.subname 期号
  828. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  829. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  830. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  831. * @apiSuccess {String} journal.pic_gd 小刊推广图
  832. * @apiSuccess {String} journal.pdate 时间
  833. * @apiSuccess {String} journal.num_ding 订阅数
  834. * @apiSuccess {String} journal.num_view 浏览量
  835. * @apiSuccess {String} journal.num_comment 评论量
  836. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2免费 3会员
  837. * @apiSuccess {String} journal.bgmusic 小刊背景音乐
  838. *
  839. * @apiSuccess {Object[]} subscribe 订阅列表
  840. * @apiSuccess {String} subscribe.id
  841. * @apiSuccess {String} subscribe.username 用户名
  842. * @apiSuccess {String} subscribe.avatar 头像
  843. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  844. * @apiSuccess {String} push_jingxuan.name 名称
  845. * @apiSuccess {String} push_jingxuan.pic 图片
  846. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  847. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  848. * @apiSuccess {String} push_jingxuan.cdate 时间
  849. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  850. */
  851. /**
  852. * @api {get} wonderful/main/?l=journal.getList 小刊列表
  853. * @apiVersion 1.0.0
  854. * @apiName journal.getList
  855. * @apiGroup Journal
  856. *
  857. * @apiDescription 小刊列表,按照分类读取
  858. *
  859. * @apiParam {String} signature signature
  860. * @apiParam {String} system 分类id,默认为1,传入-1就是获取全部
  861. *
  862. * @apiSuccess {Object[]} journal 小刊数据列表
  863. * @apiSuccess {String} journal.id 小刊id
  864. * @apiSuccess {String} journal.name 名称
  865. * @apiSuccess {String} journal.subname 期号
  866. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  867. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  868. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  869. * @apiSuccess {String} journal.pic_gd 小刊推广图
  870. * @apiSuccess {String} journal.pdate 时间
  871. * @apiSuccess {String} journal.num_ding 订阅数
  872. * @apiSuccess {String} journal.num_view 浏览量
  873. * @apiSuccess {String} journal.num_comment 评论量
  874. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2免费 3会员
  875. * @apiSuccess {String} journal.bgmusic 小刊背景音乐
  876. *
  877. * @apiSuccess {Object[]} push 主推小刊
  878. * @apiSuccess {String} push.id 小刊id
  879. * @apiSuccess {String} push.name 名称
  880. * @apiSuccess {String} push.num_ding 订阅数
  881. * @apiSuccess {Object[]} cate 当前分类
  882. * @apiSuccess {String} cate.id 分类id
  883. * @apiSuccess {String} cate.name 名称
  884. * @apiSuccess {Object[]} cateList 分类列表
  885. * @apiSuccess {String} cateList.id 分类id
  886. * @apiSuccess {String} cateList.name 名称
  887. */
  888. /**
  889. * @api {get} wonderful/main/?l=journal.getMyList 我的小刊列表
  890. * @apiVersion 1.0.0
  891. * @apiName journal.getMyList
  892. * @apiGroup Journal
  893. *
  894. * @apiDescription 我的小刊列表,按照分类读取
  895. *
  896. * @apiParam {String} signature signature
  897. * @apiParam {String} system 分类id
  898. *
  899. * @apiSuccess {Object[]} user 用户基本信息
  900. * @apiSuccess {String} user.id 用户id
  901. * @apiSuccess {String} user.username 用户名
  902. * @apiSuccess {String} user.avatar 头像
  903. *
  904. * @apiSuccess {Object[]} journal 小刊数据列表
  905. * @apiSuccess {String} journal.id 小刊id
  906. * @apiSuccess {String} journal.name 名称
  907. * @apiSuccess {String} journal.subname 期号
  908. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  909. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  910. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  911. * @apiSuccess {String} journal.pic_gd 小刊推广图
  912. * @apiSuccess {String} journal.pdate 时间
  913. * @apiSuccess {String} journal.num_ding 订阅数
  914. * @apiSuccess {String} journal.num_view 浏览量
  915. * @apiSuccess {String} journal.num_comment 评论量
  916. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2免费 3会员
  917. * @apiSuccess {String} journal.bgmusic 小刊背景音乐
  918. *
  919. * @apiSuccess {Object[]} push 主推小刊
  920. * @apiSuccess {String} push.id 小刊id
  921. * @apiSuccess {String} push.name 名称
  922. * @apiSuccess {String} push.num_ding 订阅数
  923. */
  924. /**
  925. * @api {get} wonderful/main/?l=journal.jingxuan 小刊精选更多
  926. * @apiVersion 1.0.0
  927. * @apiName journal.jingxuan
  928. * @apiGroup Journal
  929. *
  930. * @apiDescription 小刊精选更多
  931. *
  932. * @apiParam {String} signature signature
  933. * @apiSuccess {Object[]} push_jingxuan 精选推荐,这里可以按照page.next_page来获取下一页,无限循环
  934. * @apiSuccess {String} push_jingxuan.name 名称
  935. * @apiSuccess {String} push_jingxuan.pic 图片
  936. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  937. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  938. * @apiSuccess {String} push_jingxuan.cdate 时间
  939. */
  940. /**
  941. * @api {get} wonderful/main/?l=journal.read 小刊阅读页
  942. * @apiVersion 1.0.0
  943. * @apiName journal.read
  944. * @apiGroup Journal
  945. *
  946. * @apiDescription 小刊阅读页
  947. *
  948. * @apiParam {String} signature signature
  949. * @apiParam {Number} id 小刊id
  950. *
  951. * @apiSuccess {Object[]} content 内容数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  952. * @apiSuccess {String} content.id 内容id
  953. * @apiSuccess {String} content.type 内容类型1全屏图、2长图、3图文内容、11关联图文、12关联视频、13关联直播、4全屏视频、5留言视频、6留言音频
  954. * @apiSuccess {String} content.name 标题。type=5,6时有效
  955. * @apiSuccess {String} content.cover 音频或者视频的封面图,type=4,5,6时有效
  956. * @apiSuccess {String} content.video 视频地址。type=4,5时有效
  957. * @apiSuccess {String} content.music 音频地址。type=6时有效
  958. * @apiSuccess {String} content.pic 全屏图或者长图,type=1,2时有效
  959. * @apiSuccess {String} content.is_button 全屏图上的保存按钮,1显示2不显示,type=1时有效
  960. * @apiSuccess {String} content.button_name 全屏图上的保存按钮的文字,type=1时有效
  961. * @apiSuccess {String} content.button_color 全屏图上的保存按钮的文字颜色,type=1时有效
  962. * @apiSuccess {String} content.note 是否预约提醒1为已预约,2为未预约
  963. * @apiSuccess {Object[]} content.text 全屏图上的九个文字位置,type=1时有效
  964. * @apiSuccess {String} content.text.text 文字位置,1上左2上中3上右4中左5正中6中右7下左8下中9下右
  965. * @apiSuccess {String} content.text.name 文字内容 换行用\n隔开
  966. * @apiSuccess {String} content.text.color 文字颜色
  967. * @apiSuccess {String} content.text.bgcolor 文字背景颜色
  968. * @apiSuccess {String} content.text.bgcolor_type 是否设置文字背景颜色,1设置,2不设置,不设置则文字背景颜色为透明。
  969. * @apiSuccess {String} content.text.size 文字像素大小
  970. * @apiSuccess {Object[]} content.info type=3,11,12,13时有效,当等于11,12,13时,分别对应图文详情、视频详情、直播详情里的字段,等于3时,请查看以下字段
  971. * @apiSuccess {String} content.info.name 标题
  972. * @apiSuccess {String} content.info.focus 焦点图
  973. * @apiSuccess {String} content.info.content 内容
  974. * @apiSuccess {String} content.info.content_array 数组内容
  975. * @apiSuccess {Object[]} content.info.author 作者
  976. */
  977. /**
  978. * @api {get} wonderful/main/?l=journal.view 小刊详情页(旧版本)
  979. * @apiVersion 1.0.0
  980. * @apiName journal.view
  981. * @apiGroup Journal
  982. *
  983. * @apiDescription 小刊详情页
  984. *
  985. * @apiParam {String} signature signature
  986. * @apiParam {Number} id 小刊id
  987. *
  988. * @apiSuccess {Object[]} info 小刊详情
  989. * @apiSuccess {String} info.id 小刊id
  990. * @apiSuccess {String} info.name 名称
  991. * @apiSuccess {String} journal.subname 期号
  992. * @apiSuccess {String} info.pic_cover 列表封面图片 暂时无效
  993. * @apiSuccess {String} info.pic_view_cover 小刊封面图片 封面图都用这个
  994. * @apiSuccess {String} info.pic_view_bg 全屏背景图,多张图片,这是一个数组
  995. * @apiSuccess {String} info.pic_gd 小刊推广图
  996. * @apiSuccess {String} info.pdate 时间
  997. * @apiSuccess {String} info.num_ding 订阅数
  998. * @apiSuccess {String} info.num_view 浏览量
  999. * @apiSuccess {String} info.num_comment 评论量
  1000. * @apiSuccess {String} info.buy 小刊是否收费 1收费 2不收费
  1001. * @apiSuccess {String} info.subscribe 是否订阅,1为已订阅2为未订阅
  1002. * @apiSuccess {String} info.active 是否有活动,1为有2为没有,有则显示分享邀请按钮
  1003. * @apiSuccess {Object[]} button 按钮判断 如果不需要这个,可以不用
  1004. * @apiSuccess {Object[]} button.read 第一个按钮 一般为购买按钮
  1005. * @apiSuccess {String} button.read.status 状态 -1不显示 1为进入阅读 2为购买
  1006. * @apiSuccess {String} button.read.name 按钮上的名字
  1007. * @apiSuccess {Object[]} button.code 第二个按钮 一般为兑换码按钮
  1008. * @apiSuccess {String} button.code.status 状态 -1不显示 1为兑换码兑换 2为购买(再次购买)
  1009. * @apiSuccess {String} button.code.name 按钮上的名字
  1010. * @apiSuccess {Object[]} button.share 第三个按钮 一般为分享邀请按钮
  1011. * @apiSuccess {String} button.share.status 状态 -1不显示 1为免费阅读赢取大礼包
  1012. * @apiSuccess {String} button.share.name 按钮上的名字
  1013. */
  1014. /**
  1015. * @api {get} wonderful/main/?l=journal.view_v1 小刊详情页(新版本)
  1016. * @apiVersion 1.0.0
  1017. * @apiName journal.view_v1
  1018. * @apiGroup Journal
  1019. *
  1020. * @apiDescription 小刊详情页(新版本)
  1021. *
  1022. * @apiParam {String} signature signature
  1023. * @apiParam {Number} id 小刊id
  1024. *
  1025. * @apiSuccess {Object[]} info 小刊详情
  1026. * @apiSuccess {String} info.id 小刊id
  1027. * @apiSuccess {String} info.name 名称
  1028. * @apiSuccess {String} journal.subname 期号
  1029. * @apiSuccess {String} info.pic_cover 列表封面图片 暂时无效
  1030. * @apiSuccess {String} info.pic_view_cover 小刊封面图片 封面图都用这个
  1031. * @apiSuccess {String} info.pic_view_bg 全屏背景图,多张图片,这是一个数组
  1032. * @apiSuccess {String} info.pic_gd 小刊推广图
  1033. * @apiSuccess {String} info.pdate 时间
  1034. * @apiSuccess {String} info.num_ding 订阅数
  1035. * @apiSuccess {String} info.num_view 浏览量
  1036. * @apiSuccess {String} info.num_comment 评论量
  1037. * @apiSuccess {String} info.buy 小刊是否收费 1收费 2不收费
  1038. * @apiSuccess {String} info.subscribe 是否订阅,1为已订阅2为未订阅
  1039. * @apiSuccess {String} info.active 是否有活动,1为有2为没有,有则显示分享邀请按钮
  1040. * @apiSuccess {Object[]} button 按钮判断 如果不需要这个,可以不用
  1041. * @apiSuccess {Object[]} button.read 第一个按钮 阅读按钮
  1042. * @apiSuccess {String} button.read.status 状态 -1不显示按钮 1显示按钮
  1043. * @apiSuccess {String} button.read.name 按钮上的名字
  1044. * @apiSuccess {Object[]} button.buy 第二个按钮 购买按钮
  1045. * @apiSuccess {String} button.buy.status 状态 -1不显示按钮 1显示按钮
  1046. * @apiSuccess {String} button.buy.name 按钮上的名字
  1047. * @apiSuccess {Object[]} button.code 第三个按钮 兑换码按钮
  1048. * @apiSuccess {String} button.code.status 状态 -1不显示按钮 1显示按钮
  1049. * @apiSuccess {String} button.code.name 按钮上的名字
  1050. * @apiSuccess {Object[]} button.share 第四个按钮 分享邀请按钮
  1051. * @apiSuccess {String} button.share.status 状态 -1不显示按钮 1显示按钮
  1052. * @apiSuccess {String} button.share.name 按钮上的名字
  1053. */
  1054. /**
  1055. * @api {get} wonderful/main/?l=journal.active 小刊活动页
  1056. * @apiVersion 1.0.0
  1057. * @apiName journal.active
  1058. * @apiGroup Journal
  1059. *
  1060. * @apiDescription 小刊活动页
  1061. *
  1062. * @apiParam {String} signature signature
  1063. * @apiParam {Number} id 小刊id
  1064. *
  1065. * @apiSuccess {Object[]} info 小刊详情
  1066. * @apiSuccess {String} info.id 小刊id
  1067. * @apiSuccess {String} info.name 名称
  1068. *
  1069. * @apiSuccess {Object[]} active 活动说明表
  1070. * @apiSuccess {String} active.name 名称
  1071. * @apiSuccess {String} active.status 活动状态 1活动进行中 2活动已结束
  1072. * @apiSuccess {String} active.desc 描述
  1073. * @apiSuccess {String} active.buy_title 购买标题
  1074. * @apiSuccess {String} active.buy_desc 购买描述
  1075. * @apiSuccess {String} active.invite_title 邀请好友标题
  1076. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  1077. * @apiSuccess {String} active.content 活动说明,富文本
  1078. * @apiSuccess {Object[]} invite 我的邀请
  1079. * @apiSuccess {String} invite.uid 用户id
  1080. * @apiSuccess {String} invite.username 用户名
  1081. * @apiSuccess {String} invite.avatar 头像
  1082. * @apiSuccess {String} buy 是否显示购买按钮,1显示,2不显示
  1083. */
  1084. /**
  1085. * @api {get} wonderful/main/?l=journal.buy 小刊购买页
  1086. * @apiVersion 1.0.0
  1087. * @apiName journal.buy
  1088. * @apiGroup Journal
  1089. *
  1090. * @apiDescription 小刊购买页
  1091. *
  1092. * @apiParam {String} signature signature
  1093. * @apiParam {Number} id 小刊id
  1094. *
  1095. * @apiSuccess {Object[]} info 小刊详情
  1096. * @apiSuccess {String} info.id 小刊id
  1097. * @apiSuccess {String} info.name 名称
  1098. *
  1099. * @apiSuccess {String} buy_desc 购买说明
  1100. * @apiSuccess {Object[]} buy_list 购买列表
  1101. * @apiSuccess {String} buy_list.id 购买id 支付时使用
  1102. * @apiSuccess {String} buy_list.name 名称
  1103. * @apiSuccess {String} buy_list.price 标价
  1104. * @apiSuccess {String} buy_list.cash 实际支付价格
  1105. */
  1106. /**
  1107. * @api {get} wonderful/main/?l=journal.buy_action 发起支付
  1108. * @apiVersion 1.0.0
  1109. * @apiName journal.buy_action
  1110. * @apiGroup Journal
  1111. *
  1112. * @apiDescription 发起支付:请注意,如果是苹果支付,请在发起苹果支付之后,将苹果返回的验证数据,传入该接口
  1113. *
  1114. * @apiParam {String} signature signature
  1115. * @apiParam {String} journal_id 小刊id
  1116. * @apiParam {String} buy_id 购买本数id
  1117. * @apiParam {String} receipt 当header中的source_type为ios时,请传入该参数,参数的值为苹果支付后返回的参数,即可发起支付验证。
  1118. *
  1119. * @apiSuccess {Object[]} pay 微信支付返回的数据
  1120. * @apiSuccess {String} pay.time 服务器时间戳
  1121. * @apiSuccess {String} pay.nonce_str 随机字符串
  1122. * @apiSuccess {String} pay.prepay_id 统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package
  1123. * @apiSuccess {String} pay.sign_type 签名算法
  1124. * @apiSuccess {String} pay.sign 签名
  1125. * @apiSuccess {String} pay.yes 苹果支付时显示改参数,1为支付成功2为支付失败
  1126. */
  1127. /**
  1128. * @api {get} wonderful/main/?l=journal.code 提交兑换码
  1129. * @apiVersion 1.0.0
  1130. * @apiName journal.code
  1131. * @apiGroup Journal
  1132. * @apiDescription 提交兑换码
  1133. *
  1134. * @apiParam {String} signature signature
  1135. * @apiParam {String} journal_id 小刊id
  1136. * @apiParam {String} code 兑换码
  1137. *
  1138. * @apiSuccess {String} order_id 兑换成功则返回订单id
  1139. */
  1140. /**
  1141. * @api {get} wonderful/main/?l=journal.checkCode 验证兑换码是否有效
  1142. * @apiVersion 1.0.0
  1143. * @apiName journal.checkCode
  1144. * @apiGroup Journal
  1145. *
  1146. * @apiDescription 验证兑换码是否有效
  1147. *
  1148. * @apiParam {String} signature signature
  1149. * @apiParam {String} code 兑换码
  1150. * @apiSuccess {Object[]} product 小刊信息
  1151. * @apiSuccess {String} product.id 小刊id
  1152. * @apiSuccess {String} product.name 小刊名称
  1153. */
  1154. /**
  1155. * @api {get} wonderful/main/?l=journal.score 小刊积分排行榜
  1156. * @apiVersion 1.0.0
  1157. * @apiName journal.score
  1158. * @apiGroup Journal
  1159. *
  1160. * @apiDescription 小刊积分排行榜
  1161. *
  1162. * @apiParam {String} signature signature
  1163. * @apiParam {Number} id 小刊id
  1164. *
  1165. * @apiSuccess {Object[]} info 小刊详情
  1166. * @apiSuccess {String} info.id 小刊id
  1167. * @apiSuccess {String} info.name 名称
  1168. *
  1169. * @apiSuccess {Object[]} score 积分排行
  1170. * @apiSuccess {String} score.uid 用户id
  1171. * @apiSuccess {String} score.score 积分数
  1172. * @apiSuccess {String} score.username 用户名
  1173. * @apiSuccess {String} score.avatar 头像
  1174. * @apiSuccess {Object[]} my 我的积分排行
  1175. * @apiSuccess {String} my.uid 用户id
  1176. * @apiSuccess {String} my.score 积分数
  1177. * @apiSuccess {String} my.username 用户名
  1178. * @apiSuccess {String} my.avatar 头像
  1179. * @apiSuccess {String} my.pai 我的排行
  1180. *
  1181. * @apiSuccess {Object[]} active 活动说明表
  1182. * @apiSuccess {String} active.name 名称
  1183. * @apiSuccess {String} active.status 活动状态 1活动进行中 2活动已结束
  1184. * @apiSuccess {String} active.desc 描述
  1185. * @apiSuccess {String} active.invite_title 邀请好友标题
  1186. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  1187. * @apiSuccess {String} active.content 活动说明,富文本
  1188. */
  1189. /**
  1190. * @api {get} wonderful/main/?l=journal.invite 小刊我的邀请排行榜
  1191. * @apiVersion 1.0.0
  1192. * @apiName journal.invite
  1193. * @apiGroup Journal
  1194. *
  1195. * @apiDescription 小刊邀请排行榜
  1196. *
  1197. * @apiParam {String} signature signature
  1198. * @apiParam {Number} id 小刊id
  1199. *
  1200. * @apiSuccess {Object[]} info 小刊详情
  1201. * @apiSuccess {String} info.id 小刊id
  1202. * @apiSuccess {String} info.name 名称
  1203. *
  1204. * @apiSuccess {Object[]} invite 邀请排行
  1205. * @apiSuccess {String} invite.uid 用户id
  1206. * @apiSuccess {String} invite.username 用户名
  1207. * @apiSuccess {String} invite.avatar 头像
  1208. */
  1209. /**
  1210. * @api {get} wonderful/main/?l=user.my 获取用户信息
  1211. * @apiVersion 1.0.0
  1212. * @apiName user.my
  1213. * @apiGroup User
  1214. *
  1215. * @apiDescription 获取用户信息
  1216. *
  1217. * @apiParam {String} signature signature
  1218. *
  1219. * @apiSuccess {Object[]} user 用户基本信息
  1220. * @apiSuccess {String} user.id 用户id
  1221. * @apiSuccess {String} user.username 用户名
  1222. * @apiSuccess {String} user.mobile 手机号
  1223. * @apiSuccess {String} user.avatar 头像
  1224. * @apiSuccess {String} user.level 等级
  1225. * @apiSuccess {String} user.score 积分
  1226. * @apiSuccess {Number} user_msg 用户新消息数
  1227. */
  1228. /**
  1229. * @api {get} wonderful/main/?l=user.my_msg 获取我的消息
  1230. * @apiVersion 1.0.0
  1231. * @apiName user.my_msg
  1232. * @apiGroup User
  1233. *
  1234. * @apiDescription 获取我的消息
  1235. *
  1236. * @apiParam {String} signature signature
  1237. *
  1238. * @apiSuccess {Object[]} msg 消息列表
  1239. * @apiSuccess {String} msg.uid 用户id
  1240. * @apiSuccess {String} msg.from_uid 消息来源uid,暂时不用管
  1241. * @apiSuccess {String} msg.name 消息标题
  1242. * @apiSuccess {String} msg.content 消息内容
  1243. * @apiSuccess {String} msg.cdate 时间戳
  1244. * @apiSuccess {String} msg.cdate_time 转换成了Y-m-d H:i:s的时间
  1245. * @apiSuccess {String} msg.status 消息已读状态1未读2已读
  1246. * @apiSuccess {String} msg.type 消息类型,暂时不用管
  1247. */
  1248. /**
  1249. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  1250. * @apiVersion 1.0.0
  1251. * @apiName user.my_up
  1252. * @apiGroup User
  1253. *
  1254. * @apiDescription 获取我喜欢的信息
  1255. *
  1256. * @apiParam {String} signature signature
  1257. *
  1258. * @apiSuccess {Object[]} like 用户基本信息
  1259. * @apiSuccess {String} like.uid 用户id
  1260. * @apiSuccess {String} like.data_id 数据id
  1261. * @apiSuccess {String} like.cdate 时间戳
  1262. * @apiSuccess {String} like.cdate_time 转换成了Y-m-d H:i:s的时间
  1263. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  1264. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  1265. * @apiSuccess {String} like.info.id 数据id
  1266. * @apiSuccess {String} like.info.name 名称
  1267. * @apiSuccess {String} like.info.cate_id 栏目ID
  1268. * @apiSuccess {String} like.info.cate_name 栏目名称
  1269. * @apiSuccess {String} like.info.pic_cover 4:3图片
  1270. * @apiSuccess {String} like.info.pic_cover_169 16:9图片
  1271. * @apiSuccess {String} like.info.pdate 发布时间
  1272. */
  1273. /**
  1274. * @api {get} wonderful/main/?l=user.my_comment 获取我评论的信息
  1275. * @apiVersion 1.0.0
  1276. * @apiName user.my_comment
  1277. * @apiGroup User
  1278. *
  1279. * @apiDescription 获取我喜欢的信息
  1280. *
  1281. * @apiParam {String} signature signature
  1282. *
  1283. * @apiSuccess {Object[]} comment 用户基本信息
  1284. * @apiSuccess {String} comment.uid 用户id
  1285. * @apiSuccess {String} comment.data_id 数据id
  1286. * @apiSuccess {String} comment.content 评论内容
  1287. * @apiSuccess {String} comment.time 时间:x小时前
  1288. * @apiSuccess {String} comment.cdate 时间戳
  1289. * @apiSuccess {String} comment.cdate_time 转换成了Y-m-d H:i:s的时间
  1290. * @apiSuccess {String} comment.type 类型,参考公共参数中的类型设置说明中的type说明
  1291. * @apiSuccess {Object[]} comment.info 基本信息 根据type不同,里面的字段有所不同
  1292. * @apiSuccess {String} comment.info.id 数据id
  1293. * @apiSuccess {String} comment.info.name 名称
  1294. * @apiSuccess {String} comment.info.cate_id 栏目ID
  1295. * @apiSuccess {String} comment.info.cate_name 栏目名称
  1296. * @apiSuccess {String} comment.info.pic_cover 4:3图片
  1297. * @apiSuccess {String} comment.info.pic_cover_169 16:9图片
  1298. * @apiSuccess {String} comment.info.pdate 发布时间
  1299. */