apidoc.php 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  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 | 链接:10 | 评论: 11
  35. * @apiParam {Number} push_ 所有带push_开头的返回参数,返回字典都是一样的,参考获取首页数据中的push_focus
  36. */
  37. /**
  38. * @api {get} wonderful/passport/?l=applet.bind 用户登录
  39. * @apiVersion 1.0.0
  40. * @apiName applet.bind
  41. * @apiGroup AppletPassport
  42. *
  43. * @apiDescription 用户登录
  44. *
  45. * @apiParam {String} code 微信登录返回的code
  46. *
  47. * @apiSuccess {Number} vid 微信id,请保存在本地
  48. * @apiSuccess {Number} uid 用户id,请保存在本地
  49. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  50. */
  51. /**
  52. * @api {get} wonderful/passport/?l=applet.update 更新用户信息
  53. * @apiVersion 1.0.0
  54. * @apiName applet.update
  55. * @apiGroup AppletPassport
  56. *
  57. * @apiDescription 更新用户信息
  58. *
  59. * @apiParam {String} nickname 用户昵称
  60. * @apiParam {String} avatarurl 用户头像
  61. * @apiParam {String} iv 微信的加密参数
  62. * @apiParam {String} encryptedData 微信的加密参数
  63. * @apiParam {Number} vid 微信id
  64. * @apiParam {Number} uid 用户id
  65. * @apiParam {String} signature signature
  66. *
  67. *
  68. * @apiSuccess {Number} vid 微信id,请保存在本地
  69. * @apiSuccess {Number} uid 用户id,请保存在本地
  70. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  71. */
  72. /**
  73. * @api {get} wonderful/passport/?l=applet.mobile 更新用户手机号-微信绑定
  74. * @apiVersion 1.0.0
  75. * @apiName applet.mobile
  76. * @apiGroup AppletPassport
  77. *
  78. * @apiDescription 更新用户手机号-微信绑定
  79. *
  80. * @apiParam {String} iv 微信的加密参数
  81. * @apiParam {String} encryptedData 微信的加密参数
  82. * @apiParam {Number} vid 微信id
  83. * @apiParam {Number} uid 用户id
  84. * @apiParam {String} signature signature
  85. *
  86. *
  87. * @apiSuccess {Number} vid 微信id,请保存在本地
  88. * @apiSuccess {Number} uid 用户id,请保存在本地
  89. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  90. */
  91. /**
  92. * @api {get} wonderful/passport/?l=applet.bind_mobile 更新用户手机号-验证码绑定
  93. * @apiVersion 1.0.0
  94. * @apiName applet.bind_mobile
  95. * @apiGroup AppletPassport
  96. *
  97. * @apiDescription 更新用户手机号-验证码绑定
  98. *
  99. * @apiParam {Number} uid 用户id
  100. * @apiParam {Number} mobile 手机号
  101. * @apiParam {String} mcode 验证码
  102. * @apiParam {String} signature signature
  103. *
  104. * @apiSuccess {Number} uid 用户id,请保存在本地
  105. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  106. */
  107. /**
  108. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码
  109. * @apiVersion 1.0.0
  110. * @apiName reg.getMCode
  111. * @apiGroup AppletPassport
  112. *
  113. * @apiDescription 获取手机验证码
  114. *
  115. * @apiParam {Number} mobile 手机号
  116. *
  117. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  118. */
  119. /**
  120. * @api {get} wonderful/passport/?l=reg.getMCode 获取手机验证码,未登录状态
  121. * @apiVersion 1.0.0
  122. * @apiName reg.getMCode
  123. * @apiGroup AppPassport
  124. *
  125. * @apiDescription 获取手机验证码,未登录状态
  126. *
  127. * @apiParam {Number} mobile 手机号
  128. *
  129. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  130. */
  131. /**
  132. * @api {get} wonderful/passport/?l=reg.getMCodeLogin 获取手机验证码,已登录状态
  133. * @apiVersion 1.0.0
  134. * @apiName reg.getMCode
  135. * @apiGroup AppPassport
  136. *
  137. * @apiDescription 获取手机验证码,已登录状态
  138. *
  139. * @apiParam {Number} mobile 手机号
  140. * @apiParam {String} signature signature
  141. *
  142. * @apiSuccess {String} msg 验证码已发送至您的手机,请注意查收,十分钟之内有效
  143. */
  144. /**
  145. * @api {get} wonderful/passport/?l=app.login 登录与注册
  146. * @apiVersion 1.0.0
  147. * @apiName app.login
  148. * @apiGroup AppPassport
  149. *
  150. * @apiDescription 登录与注册
  151. *
  152. * @apiParam {Number} mobile 手机号
  153. * @apiParam {String} code 验证码
  154. *
  155. * @apiSuccess {Number} uid 用户id,请保存在本地
  156. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  157. */
  158. /**
  159. * @api {get} wonderful/passport/?l=app.update 更新用户信息
  160. * @apiVersion 1.0.0
  161. * @apiName app.update
  162. * @apiGroup AppPassport
  163. *
  164. * @apiDescription 更新用户信息
  165. *
  166. * @apiParam {Number} signature 用户signature
  167. * @apiParam {String} avatar 头像
  168. * @apiParam {String} gender 性别
  169. * @apiParam {String} city 城市
  170. * @apiParam {String} province 省份
  171. * @apiParam {String} country 县区
  172. *
  173. * @apiSuccess {Number} uid 用户id,请保存在本地
  174. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  175. */
  176. /**
  177. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  178. * @apiVersion 1.0.0
  179. * @apiName api.get
  180. * @apiGroup Live
  181. *
  182. * @apiDescription 获取直播推流信息
  183. *
  184. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  185. *
  186. * @apiSuccess {Object[]} active 直播活动列表
  187. * @apiSuccess {String} active.id 活动id
  188. * @apiSuccess {String} acitve.name 活动名称
  189. * @apiSuccess {Object[]} active.stream 直播流列表
  190. * @apiSuccess {String} active.stream.id 推流id
  191. * @apiSuccess {String} active.stream.live 推流实际地址
  192. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  193. * @apiSuccess {String} active.stream.url_hls 播放地址
  194. * @apiSuccess {String} active.stream.url_hdl 播放地址
  195. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  196. */
  197. /**
  198. * @api {get} wonderful/live/?l=api.start 开始推流
  199. * @apiVersion 1.0.0
  200. * @apiName api.start
  201. * @apiGroup Live
  202. *
  203. * @apiDescription 开始推流
  204. *
  205. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  206. * @apiParam {Number} id 推流id
  207. *
  208. * @apiSuccess {Number} id 推流id
  209. * @apiSuccess {Number} log_id 本次推流日志id
  210. */
  211. /**
  212. * @api {get} wonderful/live/?l=api.stop 结束推流
  213. * @apiVersion 1.0.0
  214. * @apiName api.stop
  215. * @apiGroup Live
  216. *
  217. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  218. *
  219. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  220. * @apiParam {Number} id 推流id
  221. * @apiParam {Number} log_id 本次推流日志id
  222. */
  223. /**
  224. * @api {get} wonderful/main/?l=content.home 获取首页数据
  225. * @apiVersion 1.0.0
  226. * @apiName content.home
  227. * @apiGroup Content
  228. *
  229. * @apiDescription 获取首页数据
  230. *
  231. * @apiParam {String} signature signature
  232. *
  233. *
  234. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  235. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  236. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  237. * @apiSuccess {String} config.info 系统介绍
  238. * @apiSuccess {String} config.logo 系统logo
  239. * @apiSuccess {Object[]} menu 栏目
  240. * @apiSuccess {String} menu.name 名称
  241. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  242. * @apiSuccess {Object[]} push_focus 焦点图
  243. * @apiSuccess {String} push_focus.name 名称
  244. * @apiSuccess {String} push_focus.pic 图片
  245. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  246. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  247. * @apiSuccess {String} push_focus.link 当type==10时有效,链接
  248. * @apiSuccess {String} push_focus.cdate 时间
  249. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  250. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  251. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  252. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  253. * @apiSuccess {Object[]} news 更多图文等数据
  254. * @apiSuccess {String} news.id 图文id
  255. * @apiSuccess {String} news.name 名称
  256. * @apiSuccess {String} news.pic_cover 图片
  257. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  258. * @apiSuccess {String} news.pdate 时间
  259. * @apiSuccess {String} news.num_view 浏览量
  260. * @apiSuccess {String} news.num_up 喜欢量
  261. * @apiSuccess {String} news.num_comment 评论量
  262. * @apiSuccess {String} news.num_ding 订阅量
  263. * @apiSuccess {String} news.num_user 在线人数
  264. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  265. * @apiSuccess {String} news.share_title 分享标题
  266. * @apiSuccess {String} news.share_pic 分享图片
  267. * @apiSuccess {String} news.share_content 分享内容
  268. */
  269. /**
  270. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  271. * @apiVersion 1.0.0
  272. * @apiName content.up
  273. * @apiGroup Content
  274. *
  275. * @apiDescription 精选推荐更多
  276. *
  277. * @apiParam {String} signature signature
  278. *
  279. *
  280. * @apiSuccess {Object[]} push_up 栏目,字段同上
  281. * @apiSuccess {String} push_up.name 名称
  282. * @apiSuccess {String} push_up.pic 图片
  283. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  284. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  285. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  286. * @apiSuccess {String} push_up.cdate 时间
  287. */
  288. /**
  289. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  290. * @apiVersion 1.0.0
  291. * @apiName content.news
  292. * @apiGroup Content
  293. *
  294. * @apiDescription 精选页图文内容下拉更多
  295. *
  296. * @apiParam {String} signature signature
  297. * @apiParam {Number} menu 可选参数,栏目id
  298. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  299. *
  300. * @apiSuccess {Object[]} news 更多图文等数据
  301. * @apiSuccess {String} news.id 图文id
  302. * @apiSuccess {String} news.name 名称
  303. * @apiSuccess {String} news.pic_cover 图片
  304. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  305. * @apiSuccess {String} news.pdate 时间
  306. * @apiSuccess {String} news.num_view 浏览量
  307. * @apiSuccess {String} news.num_up 喜欢量
  308. * @apiSuccess {String} news.num_comment 评论量
  309. * @apiSuccess {String} news.num_ding 订阅量
  310. * @apiSuccess {String} news.num_user 在线人数
  311. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  312. * @apiSuccess {String} news.share_title 分享标题
  313. * @apiSuccess {String} news.share_pic 分享图片
  314. * @apiSuccess {String} news.share_content 分享内容
  315. */
  316. /**
  317. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  318. * @apiVersion 1.0.0
  319. * @apiName view.comment
  320. * @apiGroup Content
  321. *
  322. * @apiDescription 查看评论列表
  323. *
  324. * @apiParam {String} signature signature
  325. * @apiParam {Number} id 图文id
  326. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  327. *
  328. * @apiSuccess {Object[]} comment 评论列表
  329. * @apiSuccess {String} comment.id
  330. * @apiSuccess {String} comment.username 用户名
  331. * @apiSuccess {String} comment.avatar 头像
  332. * @apiSuccess {String} comment.content 内容
  333. * @apiSuccess {String} comment.num_up 点赞数
  334. * @apiSuccess {String} comment.cdate 时间
  335. */
  336. /**
  337. * @api {get} wonderful/main/?l=view.article 查看图文内容
  338. * @apiVersion 1.0.0
  339. * @apiName view.article
  340. * @apiGroup Content
  341. *
  342. * @apiDescription 查看图文内容
  343. *
  344. * @apiParam {String} signature signature
  345. * @apiParam {Number} id 图文id
  346. *
  347. * @apiSuccess {Object[]} info 图文数据
  348. * @apiSuccess {String} info.id
  349. * @apiSuccess {String} info.name 名称
  350. * @apiSuccess {String} info.pic_cover 图片
  351. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  352. * @apiSuccess {String} info.pdate 时间
  353. * @apiSuccess {String} info.cate_id 栏目ID
  354. * @apiSuccess {String} info.cate_name 栏目名称
  355. * @apiSuccess {String} info.author_id 作者ID
  356. * @apiSuccess {String} info.author_name 作者名称
  357. * @apiSuccess {String} info.num_view 浏览量
  358. * @apiSuccess {String} info.num_up 喜欢量
  359. * @apiSuccess {String} info.num_comment 评论量
  360. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  361. * @apiSuccess {String} info.share_title 分享标题
  362. * @apiSuccess {String} info.share_pic 分享图片
  363. * @apiSuccess {String} info.share_content 分享内容
  364. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  365. * @apiSuccess {String} info.content 内容
  366. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,type为5时content为音频地址
  367. *
  368. * @apiSuccess {Object[]} comment 评论列表
  369. * @apiSuccess {String} comment.id
  370. * @apiSuccess {String} comment.username 用户名
  371. * @apiSuccess {String} comment.avatar 头像
  372. * @apiSuccess {String} comment.content 内容
  373. * @apiSuccess {String} comment.cdate 时间
  374. *
  375. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  376. * @apiSuccess {String} user_act.share 用户分享数
  377. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  378. */
  379. /**
  380. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  381. * @apiVersion 1.0.0
  382. * @apiName view.vod
  383. * @apiGroup Content
  384. *
  385. * @apiDescription 查看视频内容
  386. *
  387. * @apiParam {String} signature signature
  388. * @apiParam {Number} id 视频id
  389. *
  390. * @apiSuccess {Object[]} info 视频数据
  391. * @apiSuccess {String} info.id
  392. * @apiSuccess {String} info.name 名称
  393. * @apiSuccess {String} info.pic_cover 图片
  394. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  395. * @apiSuccess {String} info.pdate 时间
  396. * @apiSuccess {String} info.cate_id 栏目ID
  397. * @apiSuccess {String} info.cate_name 栏目名称
  398. * @apiSuccess {String} info.author_id 作者ID
  399. * @apiSuccess {String} info.author_name 作者名称
  400. * @apiSuccess {String} info.num_view 浏览量
  401. * @apiSuccess {String} info.num_up 喜欢量
  402. * @apiSuccess {String} info.num_comment 评论量
  403. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  404. * @apiSuccess {String} info.share_title 分享标题
  405. * @apiSuccess {String} info.share_pic 分享图片
  406. * @apiSuccess {String} info.share_content 分享内容
  407. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  408. * @apiSuccess {String} info.content 内容
  409. *
  410. *
  411. * @apiSuccess {Object[]} comment 评论列表
  412. * @apiSuccess {String} comment.id
  413. * @apiSuccess {String} comment.username 用户名
  414. * @apiSuccess {String} comment.avatar 头像
  415. * @apiSuccess {String} comment.content 内容
  416. * @apiSuccess {String} comment.cdate 时间
  417. *
  418. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  419. * @apiSuccess {String} user_act.share 用户分享数
  420. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  421. */
  422. /**
  423. * @api {get} wonderful/main/?l=view.live 查看直播内容
  424. * @apiVersion 1.0.0
  425. * @apiName view.live
  426. * @apiGroup Content
  427. *
  428. * @apiDescription 查看直播内容
  429. *
  430. * @apiParam {String} signature signature
  431. * @apiParam {Number} id 视频id
  432. *
  433. * @apiSuccess {Object[]} info 直播数据
  434. * @apiSuccess {String} info.id
  435. * @apiSuccess {String} info.name 名称
  436. * @apiSuccess {String} info.pic_cover 封面图片
  437. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  438. * @apiSuccess {String} info.pdate 时间
  439. * @apiSuccess {String} info.cate_id 栏目ID
  440. * @apiSuccess {String} info.cate_name 栏目名称
  441. * @apiSuccess {String} info.author_id 作者ID
  442. * @apiSuccess {String} info.author_name 作者名称
  443. * @apiSuccess {String} info.sdate_time 开始时间
  444. * @apiSuccess {String} info.edate_time 结束时间
  445. * @apiSuccess {String} info.num_user 在线人数
  446. * @apiSuccess {String} info.num_view 浏览量
  447. * @apiSuccess {String} info.num_up 喜欢量
  448. * @apiSuccess {String} info.num_comment 评论量
  449. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  450. * @apiSuccess {String} info.share_title 分享标题
  451. * @apiSuccess {String} info.share_pic 分享图片
  452. * @apiSuccess {String} info.share_content 分享内容
  453. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  454. * @apiSuccess {String} info.content 直播介绍
  455. * @apiSuccess {String} info.stream 直播推流地址
  456. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  457. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  458. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  459. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  460. * @apiSuccess {String} info.url_mp4 回放播放地址
  461. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  462. *
  463. *
  464. * @apiSuccess {Object[]} comment 评论列表
  465. * @apiSuccess {String} comment.id
  466. * @apiSuccess {String} comment.username 用户名
  467. * @apiSuccess {String} comment.avatar 头像
  468. * @apiSuccess {String} comment.content 内容
  469. * @apiSuccess {String} comment.cdate 时间
  470. *
  471. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  472. * @apiSuccess {String} user_act.share 用户分享数
  473. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  474. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  475. */
  476. /**
  477. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  478. * @apiVersion 1.0.0
  479. * @apiName user.submit_up
  480. * @apiGroup UserAction
  481. *
  482. * @apiDescription 喜欢
  483. *
  484. * @apiParam {String} signature signature
  485. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  486. * @apiParam {Number} id 当前的数据id
  487. *
  488. * @apiSuccess {Number} id 当前的数据id
  489. */
  490. /**
  491. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  492. * @apiVersion 1.0.0
  493. * @apiName user.submit_note
  494. * @apiGroup UserAction
  495. *
  496. * @apiDescription 直播预约提醒
  497. *
  498. * @apiParam {String} signature signature
  499. * @apiParam {Number} type type类型
  500. * @apiParam {Number} id 当前的数据id
  501. *
  502. * @apiSuccess {Number} id 当前的数据id
  503. */
  504. /**
  505. * @api {get} wonderful/main/?l=user.submit_share 分享
  506. * @apiVersion 1.0.0
  507. * @apiName user.submit_share
  508. * @apiGroup UserAction
  509. *
  510. * @apiDescription 分享
  511. *
  512. * @apiParam {String} signature signature
  513. * @apiParam {Number} type type类型
  514. * @apiParam {Number} id 当前的数据id
  515. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,先发起分享回流接口的请求,然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  516. *
  517. * @apiSuccess {Number} id 当前的数据id
  518. */
  519. /**
  520. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  521. * @apiVersion 1.0.0
  522. * @apiName user.submit_share_reflux
  523. * @apiGroup UserAction
  524. *
  525. * @apiDescription 分享回流
  526. *
  527. * @apiParam {String} signature signature
  528. * @apiParam {Number} type type类型 scene参数中的第二个值
  529. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  530. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  531. *
  532. * @apiSuccess {Number} id 当前的数据id
  533. */
  534. /**
  535. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  536. * @apiVersion 1.0.0
  537. * @apiName user.submit_comment
  538. * @apiGroup UserAction
  539. *
  540. * @apiDescription 提交评论
  541. *
  542. * @apiParam {String} signature signature
  543. * @apiParam {Number} type type类型
  544. * @apiParam {Number} id 当前的数据id
  545. * @apiParam {String} content 评论内容
  546. *
  547. * @apiSuccess {Number} id 当前的数据id
  548. */
  549. /**
  550. * @api {get} wonderful/main/?l=journal.home 小刊首页
  551. * @apiVersion 1.0.0
  552. * @apiName journal.home
  553. * @apiGroup Journal
  554. *
  555. * @apiDescription 小刊首页
  556. *
  557. * @apiParam {String} signature signature
  558. *
  559. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  560. * @apiSuccess {String} journal.id 小刊id
  561. * @apiSuccess {String} journal.name 名称
  562. * @apiSuccess {String} journal.subname 期号
  563. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  564. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  565. * @apiSuccess {String} journal.pic_view_bg 全屏背景图-进入小刊阅读页之前的全屏背景图,可以多张切换,多个用逗号隔开,请用逗号截取成数组
  566. * @apiSuccess {String} journal.pdate 时间
  567. * @apiSuccess {String} journal.num_ding 订阅数
  568. * @apiSuccess {String} journal.num_view 浏览量
  569. * @apiSuccess {String} journal.num_comment 评论量
  570. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2不收费
  571. *
  572. * @apiSuccess {Object[]} subscribe 订阅列表
  573. * @apiSuccess {String} subscribe.id
  574. * @apiSuccess {String} subscribe.username 用户名
  575. * @apiSuccess {String} subscribe.avatar 头像
  576. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  577. * @apiSuccess {String} push_jingxuan.name 名称
  578. * @apiSuccess {String} push_jingxuan.pic 图片
  579. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  580. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  581. * @apiSuccess {String} push_jingxuan.cdate 时间
  582. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  583. */
  584. /**
  585. * @api {get} wonderful/main/?l=user.my 获取用户信息
  586. * @apiVersion 1.0.0
  587. * @apiName user.my
  588. * @apiGroup User
  589. *
  590. * @apiDescription 获取用户信息
  591. *
  592. * @apiParam {String} signature signature
  593. *
  594. * @apiSuccess {Object[]} user 用户基本信息
  595. * @apiSuccess {String} user.id 用户id
  596. * @apiSuccess {String} user.username 用户名
  597. * @apiSuccess {String} user.mobile 手机号
  598. * @apiSuccess {String} user.avatar 头像
  599. * @apiSuccess {String} user.level 等级
  600. * @apiSuccess {String} user.score 积分
  601. * @apiSuccess {Number} user_msg 用户新消息数
  602. */
  603. /**
  604. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  605. * @apiVersion 1.0.0
  606. * @apiName user.my_up
  607. * @apiGroup User
  608. *
  609. * @apiDescription 获取我喜欢的信息
  610. *
  611. * @apiParam {String} signature signature
  612. *
  613. * @apiSuccess {Object[]} like 用户基本信息
  614. * @apiSuccess {String} like.uid 用户id
  615. * @apiSuccess {String} like.data_id 数据id
  616. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  617. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  618. * @apiSuccess {String} like.info.id 数据id
  619. * @apiSuccess {String} like.info.name 名称
  620. * @apiSuccess {String} like.info.cate_id 栏目ID
  621. * @apiSuccess {String} like.info.cate_name 栏目名称
  622. * @apiSuccess {String} like.info.pic_cover 图片
  623. * @apiSuccess {String} like.info.pdate 发布时间
  624. */