apidoc.php 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994
  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 {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} code 验证码
  169. *
  170. * @apiSuccess {Number} uid 用户id,请保存在本地
  171. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  172. */
  173. /**
  174. * @api {get} wonderful/passport/?l=app.update 更新用户信息
  175. * @apiVersion 1.0.0
  176. * @apiName app.update
  177. * @apiGroup AppPassport
  178. *
  179. * @apiDescription 更新用户信息
  180. *
  181. * @apiParam {Number} signature 用户signature
  182. * @apiParam {String} avatar 头像
  183. * @apiParam {String} gender 性别
  184. * @apiParam {String} city 城市
  185. * @apiParam {String} province 省份
  186. * @apiParam {String} country 县区
  187. *
  188. * @apiSuccess {Number} uid 用户id,请保存在本地
  189. * @apiSuccess {String} signature 用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地
  190. */
  191. /**
  192. * @api {get} wonderful/live/?l=api.get 获取直播推流信息
  193. * @apiVersion 1.0.0
  194. * @apiName api.get
  195. * @apiGroup Live
  196. *
  197. * @apiDescription 获取直播推流信息
  198. *
  199. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  200. *
  201. * @apiSuccess {Object[]} active 直播活动列表
  202. * @apiSuccess {String} active.id 活动id
  203. * @apiSuccess {String} acitve.name 活动名称
  204. * @apiSuccess {Object[]} active.stream 直播流列表
  205. * @apiSuccess {String} active.stream.id 推流id
  206. * @apiSuccess {String} active.stream.live 推流实际地址
  207. * @apiSuccess {String} active.stream.url_rtmp 播放地址
  208. * @apiSuccess {String} active.stream.url_hls 播放地址
  209. * @apiSuccess {String} active.stream.url_hdl 播放地址
  210. * @apiSuccess {String} active.stream.url_pic 实时截图地址
  211. */
  212. /**
  213. * @api {get} wonderful/live/?l=api.start 开始推流
  214. * @apiVersion 1.0.0
  215. * @apiName api.start
  216. * @apiGroup Live
  217. *
  218. * @apiDescription 开始推流
  219. *
  220. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  221. * @apiParam {Number} id 推流id
  222. *
  223. * @apiSuccess {Number} id 推流id
  224. * @apiSuccess {Number} log_id 本次推流日志id
  225. */
  226. /**
  227. * @api {get} wonderful/live/?l=api.stop 结束推流
  228. * @apiVersion 1.0.0
  229. * @apiName api.stop
  230. * @apiGroup Live
  231. *
  232. * @apiDescription 结束推流 一定要调用该接口,否则不会生成回放地址
  233. *
  234. * @apiParam {String} signature 请将字符串signature_dever_2018_jm经过md5加密
  235. * @apiParam {Number} id 推流id
  236. * @apiParam {Number} log_id 本次推流日志id
  237. */
  238. /**
  239. * @api {get} wonderful/main/?l=content.home 获取首页数据
  240. * @apiVersion 1.0.0
  241. * @apiName content.home
  242. * @apiGroup Content
  243. *
  244. * @apiDescription 获取首页数据
  245. *
  246. * @apiParam {String} signature signature
  247. *
  248. *
  249. * @apiSuccess {Number} uid 用户id 所有接口中都有该项
  250. * @apiSuccess {Object[]} config 基本配置 所有接口中都有该项
  251. * @apiSuccess {String} config.name 系统名称 请将小程序和app头部名称替换为该字段
  252. * @apiSuccess {String} config.info 系统介绍
  253. * @apiSuccess {String} config.logo 系统logo
  254. * @apiSuccess {String} config.article_share_name 图文详情页分享文字
  255. * @apiSuccess {String} config.vod_share_name 视频详情页分享文字
  256. * @apiSuccess {String} config.live_share_name 直播详情页分享文字
  257. * @apiSuccess {String} config.ios_pay ios支付设置 1为不开启小程序支付,2为开启小程序支付,使用h5支付
  258. * @apiSuccess {Object[]} menu 栏目
  259. * @apiSuccess {String} menu.name 名称
  260. * @apiSuccess {String} menu.id 栏目id,访问content.news时可以使用menu=menu.id
  261. * @apiSuccess {Object[]} push_focus 焦点图
  262. * @apiSuccess {String} push_focus.name 名称
  263. * @apiSuccess {String} push_focus.pic 图片
  264. * @apiSuccess {String} push_focus.type 类型,参考公共参数中的类型设置说明中的type说明
  265. * @apiSuccess {String} push_focus.id 源表id,根据type计算路径,然后把这个id加上就是最终的path,小程序和app同样。如果没有id,则进入type相对应的列表。请做好判断!!
  266. * @apiSuccess {String} push_focus.link 当type==10时有效,链接
  267. * @apiSuccess {String} push_focus.cdate 时间
  268. * @apiSuccess {Object[]} push_link 精选分类,字段同上
  269. * @apiSuccess {Object[]} push_ad 广告位,字段同上
  270. * @apiSuccess {Object[]} push_open_ad 弹窗广告位,字段同上
  271. * @apiSuccess {Object[]} push_up 精选推荐,字段同上
  272. * @apiSuccess {Object[]} news 更多图文等数据
  273. * @apiSuccess {String} news.id 图文id
  274. * @apiSuccess {String} news.name 名称
  275. * @apiSuccess {String} news.pic_cover 图片
  276. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  277. * @apiSuccess {String} news.pdate 时间
  278. * @apiSuccess {String} news.num_view 浏览量
  279. * @apiSuccess {String} news.num_up 喜欢量
  280. * @apiSuccess {String} news.num_comment 评论量
  281. * @apiSuccess {String} news.num_ding 订阅量
  282. * @apiSuccess {String} news.num_user 在线人数
  283. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  284. * @apiSuccess {String} news.share_title 分享标题
  285. * @apiSuccess {String} news.share_pic 分享图片
  286. * @apiSuccess {String} news.share_content 分享内容
  287. */
  288. /**
  289. * @api {get} wonderful/main/?l=content.up 精选推荐更多
  290. * @apiVersion 1.0.0
  291. * @apiName content.up
  292. * @apiGroup Content
  293. *
  294. * @apiDescription 精选推荐更多
  295. *
  296. * @apiParam {String} signature signature
  297. *
  298. *
  299. * @apiSuccess {Object[]} push_up 栏目,字段同上
  300. * @apiSuccess {String} push_up.name 名称
  301. * @apiSuccess {String} push_up.pic 图片
  302. * @apiSuccess {String} push_up.type 类型,参考公共参数中的类型设置说明中的type说明
  303. * @apiSuccess {String} push_up.id 源表id,根据type计算路径,然后把这个source_id加上就是最终的path,小程序和app同样。
  304. * @apiSuccess {String} push_up.link 当type==10时有效,链接
  305. * @apiSuccess {String} push_up.cdate 时间
  306. */
  307. /**
  308. * @api {get} wonderful/main/?l=content.news 精选页图文内容下拉更多
  309. * @apiVersion 1.0.0
  310. * @apiName content.news
  311. * @apiGroup Content
  312. *
  313. * @apiDescription 精选页图文内容下拉更多
  314. *
  315. * @apiParam {String} signature signature
  316. * @apiParam {Number} menu 可选参数,栏目id
  317. * @apiParam {Number} type 可选参数,类型1为图文、2为视频、3为直播,小刊请到专门的接口获取
  318. *
  319. * @apiSuccess {Object[]} news 更多图文等数据
  320. * @apiSuccess {String} news.id 图文id
  321. * @apiSuccess {String} news.name 名称
  322. * @apiSuccess {String} news.pic_cover 图片
  323. * @apiSuccess {String} news.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  324. * @apiSuccess {String} news.pdate 时间
  325. * @apiSuccess {String} news.num_view 浏览量
  326. * @apiSuccess {String} news.num_up 喜欢量
  327. * @apiSuccess {String} news.num_comment 评论量
  328. * @apiSuccess {String} news.num_ding 订阅量
  329. * @apiSuccess {String} news.num_user 在线人数
  330. * @apiSuccess {String} news.share_yes 是否显示分享按钮 1显示 2不显示
  331. * @apiSuccess {String} news.share_title 分享标题
  332. * @apiSuccess {String} news.share_pic 分享图片
  333. * @apiSuccess {String} news.share_content 分享内容
  334. */
  335. /**
  336. * @api {get} wonderful/main/?l=view.comment 查看评论列表
  337. * @apiVersion 1.0.0
  338. * @apiName view.comment
  339. * @apiGroup Content
  340. *
  341. * @apiDescription 查看评论列表
  342. *
  343. * @apiParam {String} signature signature
  344. * @apiParam {Number} id 图文id
  345. * @apiParam {Number} type 类型,参考公共参数中的类型设置说明中的type说明
  346. *
  347. * @apiSuccess {Object[]} comment 评论列表
  348. * @apiSuccess {String} comment.id
  349. * @apiSuccess {String} comment.username 用户名
  350. * @apiSuccess {String} comment.avatar 头像
  351. * @apiSuccess {String} comment.content 内容
  352. * @apiSuccess {String} comment.num_up 点赞数
  353. * @apiSuccess {String} comment.cdate 时间
  354. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  355. * @apiSuccess {String} live_status 当type=3时,有该字段,直播状态,1为直播中,2为已结束,请根据该状态判断当前观看直播的用户是否能观看直播
  356. */
  357. /**
  358. * @api {get} wonderful/main/?l=view.article 查看图文内容
  359. * @apiVersion 1.0.0
  360. * @apiName view.article
  361. * @apiGroup Content
  362. *
  363. * @apiDescription 查看图文内容
  364. *
  365. * @apiParam {String} signature signature
  366. * @apiParam {Number} id 图文id
  367. *
  368. * @apiSuccess {Object[]} info 图文数据
  369. * @apiSuccess {String} info.id
  370. * @apiSuccess {String} info.name 名称
  371. * @apiSuccess {String} info.pic_cover 图片
  372. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  373. * @apiSuccess {String} info.pdate 时间
  374. * @apiSuccess {String} info.cate_id 栏目ID
  375. * @apiSuccess {String} info.cate_name 栏目名称
  376. * @apiSuccess {String} info.author_id 作者ID
  377. * @apiSuccess {String} info.author_name 作者名称
  378. * @apiSuccess {String} info.num_view 浏览量
  379. * @apiSuccess {String} info.num_up 喜欢量
  380. * @apiSuccess {String} info.num_comment 评论量
  381. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  382. * @apiSuccess {String} info.share_title 分享标题
  383. * @apiSuccess {String} info.share_pic 分享图片
  384. * @apiSuccess {String} info.share_content 分享内容
  385. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,如值为1,2,则显示浏览量、评论,不显示喜欢
  386. * @apiSuccess {String} info.content 内容
  387. * @apiSuccess {String} info.content_array 数组内容,请使用该字段循环,type为类型,请参考类型设置说明,content为内容,type为1时为图文内容,type为2时content为视频详情的字段,type为3时content为直播详情的字段,type为5时content为音频、type为6时是视频地址,后续增加type=5和6时的封面图,暂时没有
  388. *
  389. * @apiSuccess {Object[]} comment 评论列表
  390. * @apiSuccess {String} comment.id
  391. * @apiSuccess {String} comment.username 用户名
  392. * @apiSuccess {String} comment.avatar 头像
  393. * @apiSuccess {String} comment.content 内容
  394. * @apiSuccess {String} comment.num_up 点赞数
  395. * @apiSuccess {String} comment.cdate 时间
  396. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  397. *
  398. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  399. * @apiSuccess {String} user_act.share 用户分享数
  400. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  401. */
  402. /**
  403. * @api {get} wonderful/main/?l=view.vod 查看视频内容
  404. * @apiVersion 1.0.0
  405. * @apiName view.vod
  406. * @apiGroup Content
  407. *
  408. * @apiDescription 查看视频内容
  409. *
  410. * @apiParam {String} signature signature
  411. * @apiParam {Number} id 视频id
  412. *
  413. * @apiSuccess {Object[]} info 视频数据
  414. * @apiSuccess {String} info.id
  415. * @apiSuccess {String} info.name 名称
  416. * @apiSuccess {String} info.pic_cover 图片
  417. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  418. * @apiSuccess {String} info.pdate 时间
  419. * @apiSuccess {String} info.cate_id 栏目ID
  420. * @apiSuccess {String} info.cate_name 栏目名称
  421. * @apiSuccess {String} info.author_id 作者ID
  422. * @apiSuccess {String} info.author_name 作者名称
  423. * @apiSuccess {String} info.num_view 浏览量
  424. * @apiSuccess {String} info.num_up 喜欢量
  425. * @apiSuccess {String} info.num_comment 评论量
  426. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  427. * @apiSuccess {String} info.share_title 分享标题
  428. * @apiSuccess {String} info.share_pic 分享图片
  429. * @apiSuccess {String} info.share_content 分享内容
  430. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  431. * @apiSuccess {String} info.content 内容
  432. *
  433. *
  434. * @apiSuccess {Object[]} comment 评论列表
  435. * @apiSuccess {String} comment.id
  436. * @apiSuccess {String} comment.username 用户名
  437. * @apiSuccess {String} comment.avatar 头像
  438. * @apiSuccess {String} comment.content 内容
  439. * @apiSuccess {String} comment.num_up 点赞数
  440. * @apiSuccess {String} comment.cdate 时间
  441. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  442. *
  443. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  444. * @apiSuccess {String} user_act.share 用户分享数
  445. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  446. */
  447. /**
  448. * @api {get} wonderful/main/?l=view.live 查看直播内容
  449. * @apiVersion 1.0.0
  450. * @apiName view.live
  451. * @apiGroup Content
  452. *
  453. * @apiDescription 查看直播内容
  454. *
  455. * @apiParam {String} signature signature
  456. * @apiParam {Number} id 视频id
  457. *
  458. * @apiSuccess {Object[]} info 直播数据
  459. * @apiSuccess {String} info.id
  460. * @apiSuccess {String} info.name 名称
  461. * @apiSuccess {String} info.pic_cover 封面图片
  462. * @apiSuccess {String} info.type 类型,参考公共参数中的类型设置说明中的type说明,根据它生成path
  463. * @apiSuccess {String} info.pdate 时间
  464. * @apiSuccess {String} info.cate_id 栏目ID
  465. * @apiSuccess {String} info.cate_name 栏目名称
  466. * @apiSuccess {String} info.author_id 作者ID
  467. * @apiSuccess {String} info.author_name 作者名称
  468. * @apiSuccess {String} info.sdate_time 开始时间
  469. * @apiSuccess {String} info.edate_time 结束时间
  470. * @apiSuccess {String} info.num_user 在线人数
  471. * @apiSuccess {String} info.num_view 浏览量
  472. * @apiSuccess {String} info.num_up 喜欢量
  473. * @apiSuccess {String} info.num_comment 评论量
  474. * @apiSuccess {String} info.share_yes 是否显示分享按钮 1显示 2不显示
  475. * @apiSuccess {String} info.share_title 分享标题
  476. * @apiSuccess {String} info.share_pic 分享图片
  477. * @apiSuccess {String} info.share_content 分享内容
  478. * @apiSuccess {String} info.function 开启的功能,这是一个字符串,用逗号隔开的,1代表显示浏览量,2代表显示评论,3代表显示喜欢,4代表显示邀请阅读,如值为1,2,3,则显示浏览量、评论、喜欢,不显示邀请阅读
  479. * @apiSuccess {String} info.content 直播介绍
  480. * @apiSuccess {String} info.stream 直播推流地址
  481. * @apiSuccess {String} info.stream_rtmp 直播高清播放地址
  482. * @apiSuccess {String} info.stream_hls 直播标清播放地址
  483. * @apiSuccess {String} info.stream_hdl 直播普清播放地址
  484. * @apiSuccess {String} info.stream_pic 直播截图地址,直播中时,可以用来替代pic_cover
  485. * @apiSuccess {String} info.url_mp4 回放播放地址
  486. * @apiSuccess {String} info.status 直播状态1为未开始2为直播中3为已结束
  487. *
  488. *
  489. * @apiSuccess {Object[]} comment 评论列表
  490. * @apiSuccess {String} comment.id
  491. * @apiSuccess {String} comment.username 用户名
  492. * @apiSuccess {String} comment.avatar 头像
  493. * @apiSuccess {String} comment.content 内容
  494. * @apiSuccess {String} comment.num_up 点赞数
  495. * @apiSuccess {String} comment.cdate 时间
  496. * @apiSuccess {String} comment.up 是否点赞 1为点赞 2为未点赞
  497. *
  498. * @apiSuccess {Object[]} user_act 用户行为 当用户登录时有效
  499. * @apiSuccess {String} user_act.share 用户分享数
  500. * @apiSuccess {String} user_act.up 是否喜欢1为喜欢,2为未喜欢
  501. * @apiSuccess {String} user_act.note 是否预约提醒1为已预约,2为未预约
  502. */
  503. /**
  504. * @api {get} wonderful/main/?l=user.poster 获取海报
  505. * @apiVersion 1.0.0
  506. * @apiName user.poster
  507. * @apiGroup UserAction
  508. *
  509. * @apiDescription 获取海报
  510. *
  511. * @apiParam {String} signature signature
  512. * @apiParam {Number} type type类型
  513. * @apiParam {Number} id 当前的数据id
  514. *
  515. * @apiSuccess {String} img 海报图片
  516. */
  517. /**
  518. * @api {get} wonderful/main/?l=user.submit_up 喜欢
  519. * @apiVersion 1.0.0
  520. * @apiName user.submit_up
  521. * @apiGroup UserAction
  522. *
  523. * @apiDescription 喜欢
  524. *
  525. * @apiParam {String} signature signature
  526. * @apiParam {Number} type type类型 这里增加了一个评论点赞(喜欢),type的值为11就是 给评论点赞
  527. * @apiParam {Number} id 当前的数据id
  528. *
  529. * @apiSuccess {Number} id 当前的数据id
  530. */
  531. /**
  532. * @api {get} wonderful/main/?l=user.submit_note 直播预约提醒
  533. * @apiVersion 1.0.0
  534. * @apiName user.submit_note
  535. * @apiGroup UserAction
  536. *
  537. * @apiDescription 直播预约提醒
  538. *
  539. * @apiParam {String} signature signature
  540. * @apiParam {Number} type type类型
  541. * @apiParam {Number} id 当前的数据id
  542. *
  543. * @apiSuccess {Number} id 当前的数据id
  544. */
  545. /**
  546. * @api {get} wonderful/main/?l=user.submit_share 分享
  547. * @apiVersion 1.0.0
  548. * @apiName user.submit_share
  549. * @apiGroup UserAction
  550. *
  551. * @apiDescription 分享
  552. *
  553. * @apiParam {String} signature signature
  554. * @apiParam {Number} type type类型
  555. * @apiParam {Number} id 当前的数据id
  556. * @apiParam {String} desc 说明:这是分享的说明介绍,请不要传入该参数,底层页分享时,请把路径path设置为首页的path?scene=signature,type,id signature:当前邀请者的signature | type:当前分享的类型 图文等 | id:当前分享的图文的id,小程序中请判断,如果首页有scene参数,请在正常请求首页数据之后,将这几个数据保存到本地,(这里不要发起分享回流接口的请求,请在用户授权用户信息或者授权手机号之后再发起分享回流的接口请求,发起请求之后,请从本地删除这几个数据),然后根据scene参数中的type和id的值,跳转到type所对应的path的详情页即可。
  557. *
  558. * @apiSuccess {Number} id 当前的数据id
  559. */
  560. /**
  561. * @api {get} wonderful/main/?l=user.submit_share_reflux 分享回流
  562. * @apiVersion 1.0.0
  563. * @apiName user.submit_share_reflux
  564. * @apiGroup UserAction
  565. *
  566. * @apiDescription 分享回流
  567. *
  568. * @apiParam {String} signature signature
  569. * @apiParam {Number} type type类型 scene参数中的第二个值
  570. * @apiParam {Number} id 当前的数据id scene参数中的第三个值
  571. * @apiParam {String} source_signature 回流的源用户id,scene参数中的第一个值
  572. *
  573. * @apiSuccess {Number} id 当前的数据id
  574. */
  575. /**
  576. * @api {get} wonderful/main/?l=user.submit_comment 提交评论
  577. * @apiVersion 1.0.0
  578. * @apiName user.submit_comment
  579. * @apiGroup UserAction
  580. *
  581. * @apiDescription 提交评论
  582. *
  583. * @apiParam {String} signature signature
  584. * @apiParam {Number} type type类型
  585. * @apiParam {Number} id 当前的数据id
  586. * @apiParam {String} content 评论内容
  587. *
  588. * @apiSuccess {Number} id 当前的数据id
  589. */
  590. /**
  591. * @api {get} wonderful/main/?l=journal.home 小刊首页
  592. * @apiVersion 1.0.0
  593. * @apiName journal.home
  594. * @apiGroup Journal
  595. *
  596. * @apiDescription 小刊首页
  597. *
  598. * @apiParam {String} signature signature
  599. *
  600. * @apiSuccess {Object[]} journal 小刊数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  601. * @apiSuccess {String} journal.id 小刊id
  602. * @apiSuccess {String} journal.name 名称
  603. * @apiSuccess {String} journal.subname 期号
  604. * @apiSuccess {String} journal.pic_cover 列表封面图片 暂时无效
  605. * @apiSuccess {String} journal.pic_view_cover 小刊封面图片 封面图都用这个
  606. * @apiSuccess {String} journal.pic_view_bg 全屏背景图,多张图片,这是一个数组
  607. * @apiSuccess {String} journal.pdate 时间
  608. * @apiSuccess {String} journal.num_ding 订阅数
  609. * @apiSuccess {String} journal.num_view 浏览量
  610. * @apiSuccess {String} journal.num_comment 评论量
  611. * @apiSuccess {String} journal.buy 小刊是否收费 1收费 2不收费
  612. *
  613. * @apiSuccess {Object[]} subscribe 订阅列表
  614. * @apiSuccess {String} subscribe.id
  615. * @apiSuccess {String} subscribe.username 用户名
  616. * @apiSuccess {String} subscribe.avatar 头像
  617. * @apiSuccess {Object[]} push_jingxuan 精选推荐
  618. * @apiSuccess {String} push_jingxuan.name 名称
  619. * @apiSuccess {String} push_jingxuan.pic 图片
  620. * @apiSuccess {String} push_jingxuan.type 类型,这里为4
  621. * @apiSuccess {String} push_jingxuan.id 源表id,这里是小刊的id
  622. * @apiSuccess {String} push_jingxuan.cdate 时间
  623. * @apiSuccess {Number} push_jingxuan_more 是否显示更多按钮1显示2不显示
  624. */
  625. /**
  626. * @api {get} wonderful/main/?l=journal.read 小刊阅读页
  627. * @apiVersion 1.0.0
  628. * @apiName journal.read
  629. * @apiGroup Journal
  630. *
  631. * @apiDescription 小刊阅读页
  632. *
  633. * @apiParam {String} signature signature
  634. * @apiParam {Number} id 小刊id
  635. *
  636. * @apiSuccess {Object[]} content 内容数据列表,每页显示10条,请在翻到第7或者第8条时,请求第2页
  637. * @apiSuccess {String} content.id 内容id
  638. * @apiSuccess {String} content.type 内容类型1全屏图、2长图、3图文内容、11关联图文、12关联视频、13关联直播
  639. * @apiSuccess {String} content.pic 全屏图或者长图,type=1,2时有效
  640. * @apiSuccess {String} content.is_button 全屏图上的保存按钮,1显示2不显示,type=1时有效
  641. * @apiSuccess {String} content.button_name 全屏图上的保存按钮的文字,type=1时有效
  642. * @apiSuccess {String} content.button_color 全屏图上的保存按钮的文字颜色,type=1时有效
  643. * @apiSuccess {Object[]} content.text 全屏图上的九个文字位置,type=1时有效
  644. * @apiSuccess {String} content.text.text 文字位置,1上左2上中3上右4中左5正中6中右7下左8下中9下右
  645. * @apiSuccess {String} content.text.name 文字内容 换行用\n隔开
  646. * @apiSuccess {String} content.text.color 文字颜色
  647. * @apiSuccess {String} content.text.bgcolor 文字背景颜色
  648. * @apiSuccess {String} content.text.size 文字像素大小
  649. * @apiSuccess {Object[]} content.info type=3,11,12,13时有效,当等于11,12,13时,分别对应图文详情、视频详情、直播详情里的字段,等于3时,请查看以下字段
  650. * @apiSuccess {String} content.info.name 标题
  651. * @apiSuccess {String} content.info.focus 焦点图
  652. * @apiSuccess {String} content.info.content 内容
  653. * @apiSuccess {String} content.info.content_array 数组内容
  654. * @apiSuccess {Object[]} content.info.author 作者
  655. */
  656. /**
  657. * @api {get} wonderful/main/?l=journal.view 小刊详情页
  658. * @apiVersion 1.0.0
  659. * @apiName journal.view
  660. * @apiGroup Journal
  661. *
  662. * @apiDescription 小刊详情页
  663. *
  664. * @apiParam {String} signature signature
  665. * @apiParam {Number} id 小刊id
  666. *
  667. * @apiSuccess {Object[]} info 小刊详情
  668. * @apiSuccess {String} info.id 小刊id
  669. * @apiSuccess {String} info.name 名称
  670. * @apiSuccess {String} journal.subname 期号
  671. * @apiSuccess {String} info.pic_cover 列表封面图片 暂时无效
  672. * @apiSuccess {String} info.pic_view_cover 小刊封面图片 封面图都用这个
  673. * @apiSuccess {String} info.pic_view_bg 全屏背景图,多张图片,这是一个数组
  674. * @apiSuccess {String} info.pdate 时间
  675. * @apiSuccess {String} info.num_ding 订阅数
  676. * @apiSuccess {String} info.num_view 浏览量
  677. * @apiSuccess {String} info.num_comment 评论量
  678. * @apiSuccess {String} info.buy 小刊是否收费 1收费 2不收费
  679. * @apiSuccess {String} info.subscribe 是否订阅,1为已订阅2为未订阅
  680. * @apiSuccess {String} info.active 是否有活动,1为有2为没有,有则显示分享邀请按钮
  681. * @apiSuccess {Object[]} button 按钮判断 如果不需要这个,可以不用
  682. * @apiSuccess {Object[]} button.read 第一个按钮 一般为购买按钮
  683. * @apiSuccess {String} button.read.status 状态 -1不显示 1为进入阅读 2为购买
  684. * @apiSuccess {String} button.read.name 按钮上的名字
  685. * @apiSuccess {Object[]} button.code 第二个按钮 一般为兑换码按钮
  686. * @apiSuccess {String} button.code.status 状态 -1不显示 1为兑换码兑换 2为购买(再次购买)
  687. * @apiSuccess {String} button.code.name 按钮上的名字
  688. * @apiSuccess {Object[]} button.share 第三个按钮 一般为分享邀请按钮
  689. * @apiSuccess {String} button.share.status 状态 -1不显示 1为免费阅读赢取大礼包
  690. * @apiSuccess {String} button.share.name 按钮上的名字
  691. */
  692. /**
  693. * @api {get} wonderful/main/?l=journal.active 小刊活动页
  694. * @apiVersion 1.0.0
  695. * @apiName journal.active
  696. * @apiGroup Journal
  697. *
  698. * @apiDescription 小刊活动页
  699. *
  700. * @apiParam {String} signature signature
  701. * @apiParam {Number} id 小刊id
  702. *
  703. * @apiSuccess {Object[]} info 小刊详情
  704. * @apiSuccess {String} info.id 小刊id
  705. * @apiSuccess {String} info.name 名称
  706. *
  707. * @apiSuccess {Object[]} active 活动说明表
  708. * @apiSuccess {String} active.name 名称
  709. * @apiSuccess {String} active.desc 描述
  710. * @apiSuccess {String} active.buy_title 购买标题
  711. * @apiSuccess {String} active.buy_desc 购买描述
  712. * @apiSuccess {String} active.invite_title 邀请好友标题
  713. * @apiSuccess {String} active.invite_desc 邀请好友描述 换行用\n隔开
  714. * @apiSuccess {String} active.content 活动说明,富文本
  715. * @apiSuccess {Object[]} invite 我的邀请
  716. * @apiSuccess {String} invite.uid 用户id
  717. * @apiSuccess {String} invite.username 用户名
  718. * @apiSuccess {String} invite.avatar 头像
  719. */
  720. /**
  721. * @api {get} wonderful/main/?l=journal.buy 小刊购买页
  722. * @apiVersion 1.0.0
  723. * @apiName journal.buy
  724. * @apiGroup Journal
  725. *
  726. * @apiDescription 小刊购买页
  727. *
  728. * @apiParam {String} signature signature
  729. * @apiParam {Number} id 小刊id
  730. *
  731. * @apiSuccess {Object[]} info 小刊详情
  732. * @apiSuccess {String} info.id 小刊id
  733. * @apiSuccess {String} info.name 名称
  734. *
  735. * @apiSuccess {String} buy_desc 购买说明
  736. * @apiSuccess {Object[]} buy_list 购买列表
  737. * @apiSuccess {String} buy_list.id 购买id 支付时使用
  738. * @apiSuccess {String} buy_list.name 名称
  739. * @apiSuccess {String} buy_list.price 标价
  740. * @apiSuccess {String} buy_list.cash 实际支付价格
  741. */
  742. /**
  743. * @api {get} wonderful/main/?l=journal.buy_action 发起微信支付
  744. * @apiVersion 1.0.0
  745. * @apiName journal.buy_action
  746. * @apiGroup Journal
  747. *
  748. * @apiDescription 发起微信支付
  749. *
  750. * @apiParam {String} signature signature
  751. * @apiParam {String} journal_id 小刊id
  752. * @apiParam {String} buy_id 购买本数id
  753. * @apiParam {String} source_signature 分享人的signature,scene参数中的source_signature,用完请删除该参数。
  754. *
  755. * @apiSuccess {Object[]} pay 微信支付返回的数据
  756. * @apiSuccess {String} pay.time 服务器时间戳
  757. * @apiSuccess {String} pay.nonce_str 随机字符串
  758. * @apiSuccess {String} pay.prepay_id 统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package
  759. * @apiSuccess {String} pay.sign_type 签名算法
  760. * @apiSuccess {String} pay.sign 签名
  761. */
  762. /**
  763. * @api {get} wonderful/main/?l=journal.code 提交兑换码
  764. * @apiVersion 1.0.0
  765. * @apiName journal.code
  766. * @apiGroup Journal
  767. * @apiDescription 提交兑换码
  768. *
  769. * @apiParam {String} signature signature
  770. * @apiParam {String} journal_id 小刊id
  771. * @apiParam {String} code 兑换码
  772. * @apiParam {String} source_signature 分享人的signature,scene参数中的source_signature,用完请删除该参数。
  773. *
  774. * @apiSuccess {String} order_id 兑换成功则返回订单id
  775. */
  776. /**
  777. * @api {get} wonderful/main/?l=journal.checkCode 验证兑换码是否有效
  778. * @apiVersion 1.0.0
  779. * @apiName journal.checkCode
  780. * @apiGroup Journal
  781. *
  782. * @apiDescription 验证兑换码是否有效
  783. *
  784. * @apiParam {String} signature signature
  785. * @apiParam {String} code 兑换码
  786. * @apiSuccess {Object[]} product 小刊信息
  787. * @apiSuccess {String} product.id 小刊id
  788. * @apiSuccess {String} product.name 小刊名称
  789. */
  790. /**
  791. * @api {get} wonderful/main/?l=journal.score 小刊积分排行榜
  792. * @apiVersion 1.0.0
  793. * @apiName journal.score
  794. * @apiGroup Journal
  795. *
  796. * @apiDescription 小刊积分排行榜
  797. *
  798. * @apiParam {String} signature signature
  799. * @apiParam {Number} id 小刊id
  800. *
  801. * @apiSuccess {Object[]} info 小刊详情
  802. * @apiSuccess {String} info.id 小刊id
  803. * @apiSuccess {String} info.name 名称
  804. *
  805. * @apiSuccess {Object[]} score 积分排行
  806. * @apiSuccess {String} score.uid 用户id
  807. * @apiSuccess {String} score.score 积分数
  808. * @apiSuccess {String} score.username 用户名
  809. * @apiSuccess {String} score.avatar 头像
  810. */
  811. /**
  812. * @api {get} wonderful/main/?l=journal.invite 小刊我的邀请排行榜
  813. * @apiVersion 1.0.0
  814. * @apiName journal.invite
  815. * @apiGroup Journal
  816. *
  817. * @apiDescription 小刊邀请排行榜
  818. *
  819. * @apiParam {String} signature signature
  820. * @apiParam {Number} id 小刊id
  821. *
  822. * @apiSuccess {Object[]} info 小刊详情
  823. * @apiSuccess {String} info.id 小刊id
  824. * @apiSuccess {String} info.name 名称
  825. *
  826. * @apiSuccess {Object[]} invite 邀请排行
  827. * @apiSuccess {String} invite.uid 用户id
  828. * @apiSuccess {String} invite.username 用户名
  829. * @apiSuccess {String} invite.avatar 头像
  830. */
  831. /**
  832. * @api {get} wonderful/main/?l=user.my 获取用户信息
  833. * @apiVersion 1.0.0
  834. * @apiName user.my
  835. * @apiGroup User
  836. *
  837. * @apiDescription 获取用户信息
  838. *
  839. * @apiParam {String} signature signature
  840. *
  841. * @apiSuccess {Object[]} user 用户基本信息
  842. * @apiSuccess {String} user.id 用户id
  843. * @apiSuccess {String} user.username 用户名
  844. * @apiSuccess {String} user.mobile 手机号
  845. * @apiSuccess {String} user.avatar 头像
  846. * @apiSuccess {String} user.level 等级
  847. * @apiSuccess {String} user.score 积分
  848. * @apiSuccess {Number} user_msg 用户新消息数
  849. */
  850. /**
  851. * @api {get} wonderful/main/?l=user.my_msg 获取我的消息
  852. * @apiVersion 1.0.0
  853. * @apiName user.my_msg
  854. * @apiGroup User
  855. *
  856. * @apiDescription 获取我的消息
  857. *
  858. * @apiParam {String} signature signature
  859. *
  860. * @apiSuccess {Object[]} msg 消息列表
  861. * @apiSuccess {String} msg.uid 用户id
  862. * @apiSuccess {String} msg.from_uid 消息来源uid,暂时不用管
  863. * @apiSuccess {String} msg.name 消息标题
  864. * @apiSuccess {String} msg.content 消息内容
  865. * @apiSuccess {String} msg.cdate 时间戳
  866. * @apiSuccess {String} msg.cdate_time 转换成了Y-m-d H:i:s的时间
  867. * @apiSuccess {String} msg.status 消息已读状态1未读2已读
  868. * @apiSuccess {String} msg.type 消息类型,暂时不用管
  869. */
  870. /**
  871. * @api {get} wonderful/main/?l=user.my_up 获取我喜欢的信息
  872. * @apiVersion 1.0.0
  873. * @apiName user.my_up
  874. * @apiGroup User
  875. *
  876. * @apiDescription 获取我喜欢的信息
  877. *
  878. * @apiParam {String} signature signature
  879. *
  880. * @apiSuccess {Object[]} like 用户基本信息
  881. * @apiSuccess {String} like.uid 用户id
  882. * @apiSuccess {String} like.data_id 数据id
  883. * @apiSuccess {String} like.cdate 时间戳
  884. * @apiSuccess {String} like.cdate_time 转换成了Y-m-d H:i:s的时间
  885. * @apiSuccess {String} like.type 类型,参考公共参数中的类型设置说明中的type说明
  886. * @apiSuccess {Object[]} like.info 基本信息 根据type不同,里面的字段有所不同
  887. * @apiSuccess {String} like.info.id 数据id
  888. * @apiSuccess {String} like.info.name 名称
  889. * @apiSuccess {String} like.info.cate_id 栏目ID
  890. * @apiSuccess {String} like.info.cate_name 栏目名称
  891. * @apiSuccess {String} like.info.pic_cover 图片
  892. * @apiSuccess {String} like.info.pdate 发布时间
  893. */
  894. /**
  895. * @api {get} wonderful/main/?l=user.my_comment 获取我评论的信息
  896. * @apiVersion 1.0.0
  897. * @apiName user.my_comment
  898. * @apiGroup User
  899. *
  900. * @apiDescription 获取我喜欢的信息
  901. *
  902. * @apiParam {String} signature signature
  903. *
  904. * @apiSuccess {Object[]} comment 用户基本信息
  905. * @apiSuccess {String} comment.uid 用户id
  906. * @apiSuccess {String} comment.data_id 数据id
  907. * @apiSuccess {String} comment.content 评论内容
  908. * @apiSuccess {String} comment.time 时间:x小时前
  909. * @apiSuccess {String} comment.cdate 时间戳
  910. * @apiSuccess {String} comment.cdate_time 转换成了Y-m-d H:i:s的时间
  911. * @apiSuccess {String} comment.type 类型,参考公共参数中的类型设置说明中的type说明
  912. * @apiSuccess {Object[]} comment.info 基本信息 根据type不同,里面的字段有所不同
  913. * @apiSuccess {String} comment.info.id 数据id
  914. * @apiSuccess {String} comment.info.name 名称
  915. * @apiSuccess {String} comment.info.cate_id 栏目ID
  916. * @apiSuccess {String} comment.info.cate_name 栏目名称
  917. * @apiSuccess {String} comment.info.pic_cover 图片
  918. * @apiSuccess {String} comment.info.pdate 发布时间
  919. */