请选择 进入手机版 | 继续访问电脑版

蔚图客户服务中心

 找回密码
 立即注册

QQ登录

只需一步,快速开始

搜索
热搜: 活动 交友 discuz
查看: 1426|回复: 13

[API接口] PMS API接口For APP

 关闭 [复制链接]

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
发表于 2016-5-29 11:15:31 | 显示全部楼层 |阅读模式
APP API接口传输规则:
1、每APP安装完自动生成一个KEY(不管是以什么形式保存【比如生成一个key文件】,不管生成方式【自定义一个生成方式,比如用设备物理ID经MD5生成的字符串】),初次联网时提交到服务器记录到数据表中,以便后期传递数据做TOKEN用;
2、接口暂只提供以post方式传递;
3、接口传输地址http://batp.n01.ptisp.com.cn/app/
4、返回数据格式暂只提供json格式数据

请求公共参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,频道(系统模块)为global
act stringY 函数名,如:getChannelList
param其他具体参数,根据不同模块和数据参数也有所不同

返回公共参数说明:
名称 类型 说明
code int返回码,200正常即成功,错误码另见整合贴
msg string返回说明
data array 返回数据集
data : totalint查询总数据量,列表类有此参数,详情类无此参数
data : pagesint查询总页码,列表类有此参数,详情类无此参数
data : pagesizeint查询每页显示条数,列表类有此参数,详情类无此参数
data : curpageint当前返回页码,列表类有此参数,详情类无此参数
data : itemsarray数据记录

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "total": 21,
  6.         "pagesize": 10,
  7.         "pages": 3,
  8.         "curpage": 3,
  9.         "items": [
  10.             {
  11.                 "id": 21,
  12.                 "title": "蔚图网络有限公司",
  13.                 "link": "http://www.vtoo.cn/"
  14.             }
  15.         ]
  16.     }
  17. }
复制代码


APP API接口调用函数及数据传递说明:
1、频道(菜单)
2、文章
3、视频
4、音频
5、用户
6、圈子
7、好友
8、评论
9、APP系统配置

APP API接口返回码大全
开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 11:17:40 | 显示全部楼层
· 频道(菜单)

获取菜单
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,频道(系统模块)为global
act stringY 函数名,getChannel
type intN 0为默认即开放的频道,1为全部频道(需服务器配置文件开启,且仅供测试时使用)
pidintN 指定父频道ID,指定时仅显示指定的频道及其子级频道
stepintN 默认0,即当前详情;1一层下级;2二层下级…

返回参数说明:
名称 类型 说明
total int第一级数据总数
items array数据
items : idint频道ID
items : modelstring频道模型
items : namestring频道名称
items : dirstring频道目录,外链时为外链链接
items : typeint0封面 1列表 2外链
items : iconstring频道缩略图,即频道的图标
items : image_widthint频道缩略图宽度
items : image_heightint频道缩略图高度
items : contentstring频道内容,封面时有用
items : titlestring频道SEO标题
items : keywordsstring频道关键词
items : descriptionstring频道描述
items : parentint父频道ID
items : statuint0锁定 1正常
items : childrenarray子级频道,判断部位空数组即无子级

JSON返回示例:
  1. {
  2.     "data": [
  3.         {
  4.             "id": 6,
  5.             "model": "article",
  6.             "name": "健康",
  7.             "dir": "/html/news/jiankang",
  8.             "type": 1,
  9.             "icon": "",
  10.             "image_width": 320,
  11.             "image_height": 238,
  12.             "content": "",
  13.             "title": "",
  14.             "keywords": "",
  15.             "description": null,
  16.             "statu": 0,
  17.             "parent": 1,
  18.             "deep": 0,
  19.             "uri": "http://batp.n01.ptisp.com.cn/html/news/jiankang",
  20.             "children": [
  21.                 {
  22.                     "id": 31,
  23.                     "model": "article",
  24.                     "name": "养生",
  25.                     "dir": "/html/news/jiankang/yangsheng",
  26.                     "type": 1,
  27.                     "icon": "",
  28.                     "image_width": 320,
  29.                     "image_height": 240,
  30.                     "content": "",
  31.                     "title": "",
  32.                     "keywords": "",
  33.                     "description": null,
  34.                     "statu": 0,
  35.                     "parent": 6,
  36.                     "deep": 1,
  37.                     "uri": "http://batp.n01.ptisp.com.cn/html/news/jiankang/yangsheng"
  38.                 },
  39.                 {
  40.                     "id": 32,
  41.                     "model": "article",
  42.                     "name": "保健",
  43.                     "dir": "/html/news/jiankang/baojian",
  44.                     "type": 1,
  45.                     "icon": "",
  46.                     "image_width": 320,
  47.                     "image_height": 240,
  48.                     "content": "",
  49.                     "title": "",
  50.                     "keywords": "",
  51.                     "description": null,
  52.                     "statu": 0,
  53.                     "parent": 6,
  54.                     "deep": 1,
  55.                     "uri": "http://batp.n01.ptisp.com.cn/html/news/jiankang/baojian"
  56.                 }
  57.             ]
  58.         },
  59.         {
  60.             "id": 7,
  61.             "model": "article",
  62.             "name": "其他",
  63.             "dir": "/html/news/qita",
  64.             "type": 1,
  65.             "icon": "",
  66.             "image_width": 320,
  67.             "image_height": 240,
  68.             "content": "",
  69.             "title": "",
  70.             "keywords": "",
  71.             "description": null,
  72.             "statu": 0,
  73.             "parent": 1,
  74.             "deep": 0,
  75.             "uri": "http://batp.n01.ptisp.com.cn/html/news/qita"
  76.         }
  77.     ],
  78.     "code": 200,
  79.     "msg": "success"
  80. }
复制代码

step为0时
  1. {
  2.     "data": {
  3.         "id": 2,
  4.         "modeldir": "article",
  5.         "model": "article",
  6.         "name": "公益",
  7.         "mode": 0,
  8.         "dir": "/html/news/gongyi",
  9.         "type": 1,
  10.         "format_list": "/html/news/gongyi/list__2_{page}.html",
  11.         "format_list_pre": "list__",
  12.         "format_list_mid": "_",
  13.         "format_list_suf": ".html",
  14.         "format_detail": "/html/news/gongyi/{Y}/{M}{D}/{aid}.html",
  15.         "icon": "",
  16.         "image_width": 320,
  17.         "image_height": 240,
  18.         "title": "",
  19.         "keywords": "",
  20.         "description": "",
  21.         "content": "",
  22.         "index": "article.index.php",
  23.         "list": "article.list.php",
  24.         "detail": "article.detail.php",
  25.         "wap_index": ".index.php",
  26.         "wap_list": ".list.php",
  27.         "wap_detail": ".detail.php",
  28.         "target": "0",
  29.         "sort": 0,
  30.         "status": 1,
  31.         "parent": 1,
  32.         "draft": 0,
  33.         "draft_verify": "0",
  34.         "draft_user_group": [
  35.             ""
  36.         ]
  37.     },
  38.     "code": 200,
  39.     "msg": "success"
  40. }
复制代码
开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 18:15:58 | 显示全部楼层
· 文章

1) 获取文章列表
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,文章模块为article
act stringY 函数名,获取列表getArticleList
cidintY 频道ID
flag stringN 空为最新,文章属性有:b推荐、c滚动、h热门、s幻灯、t头条、u固顶、p图片
filter string N搜索关键字
by int N排序索引:0ID、1更新时间、2总点击、3月点击、4周点击、5日点击
order int N 排序方式:0降序、1升序
author string N指定作者
origin string N指定来源
pagesizeintN 获取条数,即每页显示几条
pageintN 默认1,当前要获取的页码

获取列表getArticleList返回参数说明:
名称 类型 说明
total int第一级数据总数
pages int第一级数据总页数
curpage int第一级数据当前页码
pagesize int第一级数据每页数据调取条数
items array数据
items : idint文章ID
items : titlestring文章标题
items : subtitlestring文章副标题
items : descriptionstring内容描述,为空自动获取内容前255字节
items : title_colorstring标题颜色,如:#ffff00
items : propertiesstring文章属性
items : authorstring作者名称
items : originstring来源
items : imagestring缩略图
items : hitsint点击次数
items : sharesint分享次数
items : channel_idint频道ID
items : uristring内容连接PC端
items : linkstringAPP用内容连接,后期看是否要用启用APP专用链接
items : timestring发布时间时间戳,便于APP自定义展示
items : timestrstring发布时间格式串
items : is_newbool是否新发布,即当天发布
items : is_openurlint是否外链:0内容 1外链
items : channel_nameint频道名称
items : regionalstring预置,区域名称,前期先不考虑
items : regional_namestring预置,区域名称

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 1,
  5.         "pages": 1,
  6.         "curpage": 1,
  7.         "pagesize": 10,
  8.         "items": [
  9.             {
  10.                 "id": 1,
  11.                 "title": "习近平:培育中美共同而非排他的",
  12.                 "subtitle": "",
  13.                 "description": "习近平出席第八轮中美战略与经济对话和第七轮中美人文交流高层磋商联合开幕式并发表重要讲话强调中美要坚定方向、锲而不舍,推动中美新型大国关系建设得到更大发展,更好造福两国人民和各国人民新华社北京6月6日电",
  14.                 "title_color": "",
  15.                 "properties": [
  16.                     "b",
  17.                     "s"
  18.                 ],
  19.                 "author": "arsio",
  20.                 "origin": "新华社",
  21.                 "image": "",
  22.                 "hits": 50,
  23.                 "shares": 0,
  24.                 "channel_id": 4,
  25.                 "uri": "http://www.pmsdev.com/article.php?id=1",
  26.                 "link": "http://www.pmsdev.com/article.php?id=1",
  27.                 "time": "1465206817",
  28.                 "timestr": "2016-06-06 17:53",
  29.                 "is_new": false,
  30.                 "is_openurl": 0,
  31.                 "channel_name": "新闻",
  32.                 "regional": 0,
  33.                 "regional_name": ""
  34.             }
  35.         ]
  36.     },
  37.     "msg": "success"
  38. }
复制代码


2) 获取文章详情
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,文章模块为article
act stringY 函数名,获取内容getArticleDetail
cidintN 频道ID
id intY 文章ID

获取列表getArticleDetail返回参数说明:
名称 类型 说明
items array数据
items : idint文章ID
items : titlestring文章标题
items : subtitlestring文章副标题
items : contentstring文章内容
items : filestring附件
items : title_colorstring标题颜色,如:#ffff00
items : propertiesstring文章属性
items : authorstring作者名称
items : originstring来源名称
items : keywordsstring关键词
items : tagsarray关键词拆分
items : descriptionstring描述
items : imagestring缩略图
items : timestring发布时间时间戳,便于APP自定义展示
items : timestrstring发布时间格式串
items : hitsint点击次数
items : sharesint分享次数
items : pluginsstring附加插件
items : is_openurlint0内容 1外链
items : uristring内容连接PC端
items : linkstringAPP用内容连接,后期看是否要用启用APP专用链接
items : channel_idint频道ID
items : channel_nameint频道名称
items : regionalstring预置,区域ID
items : regional_namestring预置,区域名称

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "items": {
  5.             "id": 1,
  6.             "title": "习近平:培育中美共同而非排他的",
  7.             "subtitle": "",
  8.             "content": "<p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; "><strong>习近平出席第八轮中美战略与经济对话和第七轮中美人文交流高层磋商联合开幕式并发表重要讲话</strong></p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; "><strong>强调中美要坚定方向、锲而不舍,推动中美新型大国关系建设得到更大发展,更好造福两国人民和各国人民</strong></p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">新华社北京6月6日电(记者刘华、臧晓程、刘红霞)国家主席习近平6日出席在钓鱼台国宾馆举行的第八轮中美战略与经济对话和第七轮中美人文交流高层磋商联合开幕式,并发表题为《为构建中美新型大国关系而不懈努力》的重要讲话,强调作为世界上最大的发展中国家、最大的发达国家和前两大经济体,中美两国应该从两国人民和各国人民根本利益出发,勇于担当,朝着构建中美新型大国关系的方向奋力前行。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平指出,3年前我同奥巴马总统在安纳伯格庄园会晤以来,在双方努力下,中美两国在双边、地区、全球层面众多领域开展合作,推动两国关系发展取得新成果,给双方带来了实实在在的利益,也有力促进了亚太地区及世界和平、稳定、发展。中美合作成果给我们最根本的启示就是,双方要坚持不冲突不对抗、相互尊重、合作共赢的原则,坚定不移推进中美新型大国关系建设。无论国际风云如何变幻,我们都应该坚持这个大方向,毫不动摇为之努力。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平强调,现在世界多极化、经济全球化、社会信息化深入推进,各国利益紧密相连。零和博弈、冲突对抗早已不合时宜,同舟共济、合作共赢成为时代要求。中美要增强两国互信。要防止浮云遮眼,避免战略误判,就要通过经常性沟通,积累战略互信。我们要积极拓展两国互利合作。要秉持共赢理念,不断提高合作水平。当前要着力加强宏观经济政策协调,同有关各方一道推动二十国集团领导人杭州峰会取得积极成果,全力争取早日达成互利共赢的中美双边投资协定,深化两国在气候变化、发展、网络、防扩散、两军、执法等领域交流合作,加强双方在重大国际和地区以及全球性问题上的沟通和协调。我们要妥善管控分歧和敏感问题。中美双方存在一些分歧是正常的,双方要努力解决或以务实和建设性的态度加以管控,只要双方遵循相互尊重、平等相待原则,坚持求同存异、聚同化异,中美两国关系就能避免受到大的干扰。我们要就亚太事务加强沟通和合作。宽广的太平洋不应该成为各国博弈的竞技场,而应该成为大家包容合作的大平台。中国奉行亲诚惠容的周边外交理念,始终致力于促进亚太和平、稳定、发展。中美在亚太地区拥有广泛共同利益,应该保持经常性对话,开展更多合作,应对各种挑战,努力培育两国共同而非排他的“朋友圈”,都做地区繁荣稳定的建设者和守护者。我们要厚植两国人民友谊。双方要为两国各界交往搭建更多平台、提供更多便利,让中美友好薪火相传、生生不息。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平指出,今年是中国实施“十三五”规划开局之年。我们对实现中国经济社会发展既定目标充满信心。中国将会为世界提供更多发展机遇,将会同包括美国在内的世界各国开展更密切的合作。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平强调,中国坚定不移走和平发展道路,倡导构建以合作共赢为核心的新型国际关系。我们愿同世界各国加强合作,共同维护以<span class="infoMblog" style="position: relative; z-index: 9; "><a class="a-tips-Article-QQ" href="http://t.qq.com/WorldFoodProgramme#pref=qqcom.keyword" rel="WorldFoodProgramme" reltitle="联合国" target="_blank" style="outline: none; color: rgb(0, 0, 0); text-decoration: none; border-bottom-width: 1px; border-bottom-style: dotted; border-bottom-color: rgb(83, 109, 166); ">联合国</a></span>宪章宗旨和原则为核心的国际秩序和国际体系,推动国际秩序朝着更加公正合理的方向发展。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平指出,中美战略与经济对话和人文交流高层磋商机制为增进两国战略互信、拓展互利合作、加深两国人民友谊发挥了重要作用。只要我们坚定方向、锲而不舍,就一定能推动中美新型大国关系建设取得更大发展,更好造福两国人民和各国人民。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">美国总统奥巴马向第八轮中美战略与经济对话和第七轮中美人文交流高层磋商发来书面致辞。奥巴马在致辞中表示,美中任何一方的成功都攸关对方的利益。过去7年来,美中携手应对了一系列重大全球性挑战。通过战略与经济对话机制,两国政府得以共同处理全球最紧迫的经济与安全问题。这些经济对话有助于双方培育合作、加强沟通以及更好地管控彼此分歧,对两国关系发展起到了支持与推动作用。美国欢迎一个稳定、和平、繁荣的中国崛起并在世界事务中发挥作用,期待着美中携手应对全球性挑战。美中两国各自拥有独特历史和传统,难以事事完全一致,但我们必须继续围绕共同挑战、共同责任及共同利益来构建双边关系,并承担维护和加强国际体系的共同义务。我们还必须努力开辟渠道,进一步加强人文交往纽带。我期待今年9月访华时与习近平主席继续推进这项重要工作。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">习近平主席特别代表国务院副总理刘延东、国务院副总理汪洋、国务委员杨洁篪和奥巴马总统特别代表国务卿克里、财政部长雅各布·卢等参加了联合开幕式。</p><p style="margin-bottom: 29px; line-height: 28px; font-family: 宋体, Arial, sans-serif; font-size: 16px; text-indent: 2em; ">本轮中美人文交流高层磋商由刘延东和克里共同主持。本轮中美战略与经济对话分别由汪洋和杨洁篪与克里和雅各布·卢共同主持。</p>",
  9.             "file": [],
  10.             "title_color": "",
  11.             "properties": [
  12.                 "b",
  13.                 "s"
  14.             ],
  15.             "author": "arsio",
  16.             "origin": "新华社",
  17.             "keywords": "习近平,第八轮中美战略,经济对话,第七轮中美人文交流高层磋商联合开幕式",
  18.             "tags": [
  19.                 "习近平",
  20.                 "第八轮中美战略",
  21.                 "经济对话",
  22.                 "第七轮中美人文交流高层磋商联合开幕式"
  23.             ],
  24.             "description": "习近平出席第八轮中美战略与经济对话和第七轮中美人文交流高层磋商联合开幕式并发表重要讲话强调中美要坚定方向、锲而不舍,推动中美新型大国关系建设得到更大发展,更好造福两国人民和各国人民新华社北京6月6日电",
  25.             "image": "",
  26.             "time": "1465206817",
  27.             "timestr": "2016-06-06 17:53",
  28.             "hits": 50,
  29.             "shares": 0,
  30.             "plugins": [],
  31.             "is_openurl": 0,
  32.             "uri": "http://www.pmsdev.com/article.php?id=1",
  33.             "link": "http://www.pmsdev.com/article.php?id=1",
  34.             "channel_id": 4,
  35.             "channel_name": "新闻",
  36.             "regional": 0,
  37.             "regional_name": ""
  38.         }
  39.     },
  40.     "msg": "success"
  41. }
复制代码
开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 18:18:12 | 显示全部楼层
· 视频

1) 获取视频专题设置列表
请求参数说明:
名称 类型 必填 说明
key string YAPP生成并记录到服务器的唯一的key值
m string Y模块名称,视频模块为video
act stringN函数名,获取专题列表getVideoTopics

获取专题设置列表getVideoTopics返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回消息
dataarray数据集
data : items array数据:键=>值,主要记录键

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "items": {
  5.             "1": "收视王牌",
  6.             "2": "推荐栏目"
  7.         }
  8.     },
  9.     "msg": "success"
  10. }
复制代码


2) 获取视频列表
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,视频模块为video
act stringY 函数名,获取列表getVideoList
cidintY 频道ID
flag stringN 空为最新,视频属性有:b推荐、c滚动、h热门、s幻灯、t头条、u固顶、p图片
topic int N专题
filter string N搜索关键字
by intN排序索引:0ID、1更新时间、2总点击、3月点击、4周点击、5日点击
orderint N 排序方式:0降序、1升序
authorstringN指定作者
originstringN指定来源
pagesizeintN 获取条数,即每页显示几条
pageintN 默认1,当前要获取的页码

获取列表getVideoList返回参数说明:
名称 类型 说明
total int第一级数据总数
pages int第一级数据总页数
curpage int第一级数据当前页码
pagesize int第一级数据每页数据调取条数
items array数据
items : idint视频ID
items : titlestring视频标题
items : subtitlestring视频副标题
items : title_colorstring标题颜色,如:#ffff00
items : propertiesstring视频属性
items : sectionstring档期
items : topicint专题
items : hoststring主持人
items : authorstring作者名称
items : descriptionstring内容描述,为空自动获取内容前255字节
items : pathstring视频路径
items : imagestring缩略图
items : hitsint点击次数
items : sharesint分享次数
items : channel_idint频道ID
items : uristring内容连接PC端
items : linkstringAPP用内容连接,后期看是否要用启用APP专用链接
items : timestring发布时间时间戳,便于APP自定义展示
items : timestrstring发布时间格式串
items : is_newint是否新文章,即当天发布
items : channel_namestring频道名称
items : regionalstring预置,区域ID
items : regional_namestring预置,区域名称

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 1,
  5.         "pages": 1,
  6.         "curpage": 1,
  7.         "pagesize": 10,
  8.         "items": [
  9.             {
  10.                 "id": 1,
  11.                 "title": "奔跑吧凶弟",
  12.                 "subtitle": "爆笑恶搞奔跑吧兄弟",
  13.                 "title_color": "",
  14.                 "properties": [
  15.                     "b",
  16.                     "h"
  17.                 ],
  18.                 "section": "2016001",
  19.                 "topic": [
  20.                     "1",
  21.                     "2"
  22.                 ],
  23.                 "host": "PMS摄制组",
  24.                 "author": "Arsio",
  25.                 "description": "爆笑调侃生活,装13必看",
  26.                 "path": "http://www.pmsdev.com/data/plugins/modules/video/20160712164011.mp4",
  27.                 "image": "",
  28.                 "hits": 0,
  29.                 "shares": 0,
  30.                 "channel_id": 8,
  31.                 "uri": "http://www.pmsdev.com/video.php?id=1",
  32.                 "link": "http://www.pmsdev.com/video.php?id=1",
  33.                 "time": "1468313856",
  34.                 "timestr": "55分钟前",
  35.                 "is_new": true,
  36.                 "channel_name": "视频",
  37.                 "regional": 0,
  38.                 "regional_name": ""
  39.             }
  40.         ]
  41.     },
  42.     "msg": "success"
  43. }
复制代码


3) 获取视频详情
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,视频模块为video
act stringY 函数名,获取内容getVideoDetail
cidintN 频道ID
id intY 视频ID

获取列表getVideoDetail返回参数说明:
名称 类型 说明
items array数据
items : idint视频ID
items : titlestring视频标题
items : subtitlestring视频副标题
items : title_colorstring标题颜色,如:#ffff00
items : propertiesstring视频属性
items : authorstring作者名称
items : originstring来源名称
items : keywordsstring关键词
items : tagsarray关键词拆分
items : descriptionstring描述
items : sectionstring档期
items : topicstring专题
items : hoststring主持人
items : pathstring视频路径
items : imagestring缩略图
items : timestring发布时间时间戳,便于APP自定义展示
items : linkstring内容连接
items : htmlstring内容页文件名,PC端用,APP不用管
items : hitsint点击次数
items : sharesint分享次数
items : pluginsstring附加插件
items : channel_idint频道ID
items : channel_nameint频道名称
items : regionalstring预置,区域ID
items : regional_namestring预置,区域名称

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "items": {
  5.             "id": 1,
  6.             "title": "奔跑吧凶弟",
  7.             "subtitle": "爆笑恶搞奔跑吧兄弟",
  8.             "title_color": "",
  9.             "properties": [
  10.                 "b",
  11.                 "h"
  12.             ],
  13.             "author": "Arsio",
  14.             "origin": "",
  15.             "keywords": "",
  16.             "tags": [],
  17.             "description": "爆笑调侃生活,装13必看",
  18.             "section": "2016001",
  19.             "topic": [
  20.                 "1",
  21.                 "2"
  22.             ],
  23.             "host": "PMS摄制组",
  24.             "path": "http://www.pmsdev.com/data/plugins/modules/video/20160712164011.mp4",
  25.             "image": "",
  26.             "time": "1468313856",
  27.             "link": "http://www.pmsdev.com/video.php?id=1",
  28.             "html": "1",
  29.             "hits": 0,
  30.             "shares": 0,
  31.             "plugins": [
  32.                 "comment"
  33.             ],
  34.             "channel_id": 8,
  35.             "channel_name": "视频",
  36.             "regional": 0,
  37.             "regional_name": ""
  38.         }
  39.     },
  40.     "msg": "success"
  41. }
复制代码
开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 18:20:02 | 显示全部楼层
· 音频

1) 获取音频风格列表
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,音频模块为audio
act stringY 函数名,获取列表getAudioStyles

获取风格列表getAudioStyles返回参数说明:
名称 类型 说明
total int数据总数
items array数据

JSON返回示例:
  1. {
  2.     "code": "200",
  3.     "msg": "Success",
  4.     "data": {
  5.         "items": {
  6.             "1":"流行",
  7.             "2":"古典",
  8.             "3":"流行"
  9.         }
  10.     }
  11. }
复制代码

2) 获取音频列表
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,音频模块为audio
act stringY 函数名,获取列表getAudioList
cidintY 频道ID
styleintY 风格
flag stringN 空为最新,音频属性有:b推荐、c滚动、h热门、s幻灯、t头条、u固顶、p图片
filter string N搜索关键字
by intN排序索引:0ID、1更新时间、2总点击、3月点击、4周点击、5日点击
orderint N 排序方式:0降序、1升序
singerstringN指定歌手
recordstringN指定专辑
pagesizeintN 获取条数,即每页显示几条
pageintN 默认1,当前要获取的页码

获取列表getAudioList返回参数说明:
名称 类型 说明
total int第一级数据总数
pages int第一级数据总页数
curpage int第一级数据当前页码
pagesize int第一级数据每页数据调取条数
items array数据
items : idint音频ID
items : titlestring音频标题
items : subtitlestring音频副标题
items : styleint风格数值
items : stylenameint风格名称
items : singerstring歌手
items : recordstring专辑
items : pathstring音频路径
items : title_colorstring标题颜色,如:#ffff00
items : propertiesarray音频属性
items : descriptionstring内容描述,为空自动获取内容前255字节
items : imagestring缩略图
items : sharesint分享次数
items : hitsint点击次数
items : timestring发布时间时间戳,便于APP自定义展示
items : timestrstring发布时间时间格式,如4分钟前,昨天
items : channel_idint频道ID
items : channel_nameint频道名称
items : user_idint作者ID
items : authorstring作者名称
items : regionalint预置,区域值,前期先不考虑
items : regional_namestring区域名称

JSON返回示例:
  1. {
  2.     "code": "200",
  3.     "msg": "Success",
  4.     "data": {
  5.         "total": 12,
  6.         "pages": 2,
  7.         "curpage": 2,
  8.         "pagesize": 10,
  9.         "items": [{
  10.             "id": "2",
  11.             "title": "说不出口 (《欢乐颂》电视剧插曲)",
  12.             "subtitle": "",
  13.             "style": "1",
  14.             "stylename": "流行",
  15.             "singer": "刘涛",
  16.             "record": "欢乐颂 电视剧原声带",
  17.             "path": "http://cc.stream.qqmusic.qq.com/C2000006EbT71YMbWF.m4a?vkey=7FFE8C38ABC0E2165D3AB94C0A25E47CB16F90206139E7927945CE03D544C7BDF7F89BCC171F60C9985AA6E9604385128234ADB50E881D94&guid=8666965899&fromtag=30",
  18.             "title_color": "#dddddd",
  19.             "properties": ["t","p"],
  20.             "description": "说不出口 (《欢乐颂》电视剧插曲)。",
  21.             "image": "http://i.gtimg.cn/music/photo/mid_album_300/3/l/000Thobb4Wej3l.jpg",
  22.             "shares": "22",
  23.             "hits": "126",
  24.             "time": "1289169689",
  25.             "timestr": "6天前",
  26.             "channel_id": 4,
  27.             "channel_name": "音乐",
  28.             "user_id": 2,
  29.             "author": "youki",
  30.             "regional": "367",
  31.             "regional_name": "上海"
  32.         },{
  33.             "id": "1",
  34.             "title": "存在感",
  35.             "subtitle": "",
  36.             "style": "1",
  37.             "stylename": "流行",
  38.             "singer": "李宇春",
  39.             "record": "野",
  40.             "path": "http://cc.stream.qqmusic.qq.com/C200000NHKF71FpiAH.m4a?vkey=09AA87D669CDD30C1105811A4B881845187221F415CAACBB340165D46140966EFEC7914A9DE77744EB8012B0F9A7748E754A21D5930CC671&guid=8666965899&fromtag=30",
  41.             "title_color": "#cc6600",
  42.             "properties": ["b","p"],
  43.             "description": "作为《野蛮生长》的开篇之作,《野》充满了青年荷尔蒙的原发懵懂,叛逆不羁又单纯美好,有着义无反顾的信念和力量。如一夜暴雨后的三月野草,发自生命本能的尽情生长,旁若无人的长出一坡青葱,不可阻挡的野蛮之力,蓬勃动人。",
  44.             "image": "http://i.gtimg.cn/music/photo/mid_album_300/0/P/001Fet5N4KZW0P.jpg",
  45.             "shares": "22",
  46.             "hits": "123",
  47.             "time": "1289169789",
  48.             "timestr": "6天前",
  49.             "channel_id": 3,
  50.             "channel_name": "音乐",
  51.             "user_id": 2,
  52.             "author": "youki",
  53.             "regional": "367",
  54.             "regional_name": "上海"
  55.         }]
  56.     }
  57. }
复制代码

3) 获取音频详情
请求参数说明:
名称 类型 必填 说明
key string Y APP生成并记录到服务器的唯一的key值
m string Y 模块名称,音频模块为audio
act stringY 函数名,获取内容getAudioDetail
cidintN 频道ID
id intY 音频ID

获取列表getAudioDetail返回参数说明:
名称 类型 说明
items array数据
items : idint音频ID
items : linkstring内容分享连接
items : titlestring音频标题
items : subtitlestring音频副标题
items : styleint风格数值
items : stylenameint风格名称
items : singerstring歌手
items : recordstring专辑
items : pathstring音频路径
items : title_colorstring标题颜色,如:#ffff00
items : propertiesarray音频属性
items : authorstring作者名称
items : originstring来源名称
items : keywordsarray关键词
items : descriptionstring描述
items : lyricsstring歌词
items : imagestring缩略图
items : pluginsarray附加插件
items : sharesint分享次数
items : hitsint点击次数
items : timestring发布时间时间戳,便于APP自定义展示
items : timestrstring发布时间时间格式,如4分钟前,昨天
items : channel_idint频道ID
items : channel_nameint频道名称
items : user_idint作者ID
items : regionalint预置,区域值,前期先不考虑
items : regional_namestring区域名称

JSON返回示例:
  1. {
  2.     "code": "200",
  3.     "msg": "Success",
  4.     "data": {
  5.         "items": {
  6.             "id": "1",
  7.             "link": "http://y.qq.com/#type=song&mid=000NHKF71FpiAH&tpl=yqq_song_detail",
  8.             "title": "存在感",
  9.             "subtitle": "",
  10.             "style": "1",
  11.             "stylename": "流行",
  12.             "singer": "李宇春",
  13.             "record": "野",
  14.             "path": "http://cc.stream.qqmusic.qq.com/C200000NHKF71FpiAH.m4a?vkey=09AA87D669CDD30C1105811A4B881845187221F415CAACBB340165D46140966EFEC7914A9DE77744EB8012B0F9A7748E754A21D5930CC671&guid=8666965899&fromtag=30",
  15.             "title_color": "#333333",
  16.             "properties": ["b","p"],
  17.             "author": "arsio",
  18.             "origin": "QQ音乐",
  19.             "keywords": ["野","野蛮生长","存在感"],
  20.             "description": "作为《野蛮生长》的开篇之作,《野》充满了青年荷尔蒙的原发懵懂,叛逆不羁又单纯美好,有着义无反顾的信念和力量。如一夜暴雨后的三月野草,发自生命本能的尽情生长,旁若无人的长出一坡青葱,不可阻挡的野蛮之力,蓬勃动人。",
  21.             "lyrics": "存在感 - 李宇春&lt;br/&gt;词:李格弟&lt;br/&gt;曲:陈伟伦&lt;br/&gt;编曲:陈伟伦&lt;br/&gt;制作人:陈伟伦&lt;br/&gt;云层肥厚 天地很宽&lt;br/&gt;疯狂爱你 与你何关&lt;br/&gt;真实过度 反变虚幻&lt;br/&gt;无辜出世 野蛮生长&lt;br/&gt;万岁少女 露出虎牙&lt;br/&gt;电子花车 失忆诊所&lt;br/&gt;付出的爱 无须回收&lt;br/&gt;能量不灭 终究轮回&lt;br/&gt;一整年的暗淡&lt;br/&gt;换十五分钟的灿烂&lt;br/&gt;无聊到死只好娱乐至上&lt;br/&gt;愈来愈淡 mmmmmm&lt;br/&gt;愈来愈薄&lt;br/&gt;存在感根本经不起&lt;br/&gt;暴烈躁郁的刷手&lt;br/&gt;亲戚计较 邻居暴走&lt;br/&gt;严刑拷打 尖叫嘶吼&lt;br/&gt;纯洁偶像 祭坛羔羊&lt;br/&gt;青春无价 只好挥霍&lt;br/&gt;只能认真的去爱&lt;br/&gt;不管最后失败&lt;br/&gt;平庸之恶&lt;br/&gt;就是沉溺于受害&lt;br/&gt;只有倾国倾城&lt;br/&gt;才能野生野长&lt;br/&gt;存在感怎能随随便便&lt;br/&gt;浪费给那些无感&lt;br/&gt;云层肥厚 天地很宽&lt;br/&gt;疯狂爱你 与你何关&lt;br/&gt;真实过度 反变虚幻&lt;br/&gt;无辜出世 野蛮生长",
  22.             "image": "http://i.gtimg.cn/music/photo/mid_album_300/0/P/001Fet5N4KZW0P.jpg",
  23.             "plugins": [],
  24.             "shares": "12",
  25.             "hits": "123",
  26.             "time": "1289169789",
  27.             "timestr": "6天前",
  28.             "channel_id": 6,
  29.             "channel_name": "音乐",
  30.             "user_id": 1,
  31.             "regional": "367",
  32.             "regional_name": "上海"
  33.         }
  34.     }
  35. }
复制代码
开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 18:22:37 | 显示全部楼层
· 用户

1) 用户注册
流程简介:
A、填入手机号mp > 获取getSMSCode,并输入短信验证码smscode > 提交下一步register > 判断成功后返回成功和注册手机的sesscode > APP记录该值用于第二步提交
B、填入登录账号account、密码password、确认密码comfirmpassword、性别sex、同意注册协议apply、附带第一步返回的注册手机的sesscode > 提交注册registerNext > 成功写入数据库并返回成功提示 > 返回登录界面登录

1.1) 获取验证码getSMSCode
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,getSMSCode
mpstringY手机号
typestringY获取类型:注册reg;绑定bind;解绑unbind;找回密码find

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": "200",
  3.     "msg": "success"
  4. }
复制代码


1.2) 注册第一步register
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,register
mpstringY手机号
smscodestringY手机短信验证码

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息
datastring返回注册手机sesscode,32位MD5的加密字段,APP记录并在下一步提交

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
  5. }
复制代码


1.3) 注册第二步registerNext
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,registerNext
sesscodestringY第一步记录的注册手机sesscode
accountstringY登录账号
passwordstringY密码
comfirmpasswordstringY确认密码
sexintY性别:0保密;1男;2女
applyintY1同意注册信息;0不同意

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": "200",
  3.     "msg": "success"
  4. }
复制代码


2) 用户登录login
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,login
accountstringY可以是登录账号、绑定的手机号、绑定的邮箱
passwordstringY登录密码

返回参数说明:
名称 类型 说明
uidint用户的user_id
accountstring登录账号
sexint性别:0保密;1男;2女
nicknamestring昵称
emailstring邮箱地址
email_verifiedint是否已绑定,0未绑;1已绑。绑定过的可以用邮箱登录,修改绑定邮箱时需验证旧邮件验证码
mpstring手机号
mp_verifiedint是否已绑定,0未绑;1已绑。绑定过的可以用手机号登录,修改绑定手机时需验证旧手机验证码
secret_switchint保密设置:0完全保密;1朋友可见;2通用开放;3完全开放
safe_questionint安全问题数值,用于修改安全问题时是否需要显示并验证原问题答案用
avatarstring头像网址
access_tokenstring登录TOKEN,MD5加密过的32位字符串

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "uid": 4,
  5.         "account": "tenqnds",
  6.         "sex": 1,
  7.         "nickname": "tenqnds",
  8.         "email": "",
  9.         "email_verified": 0,
  10.         "mp": "13859877040",
  11.         "mp_verified": 1,
  12.         "secret_switch": 1,
  13.         "safe_question": 0,
  14.         "avatar": "http://www.pmsdev.com/user/images/avatar.gif",
  15.         "access_token": "f0aa28bd09d698d2d36d12bf8db800d3"
  16.     },
  17.     "msg": "success"
  18. }
复制代码


3) 可选API
3.1) 注册时判断登录账号是否已存在checkAccount
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,checkAccount
accountstringY登录账号

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 14014,
  3.     "msg": "account is exist"
  4. }
复制代码


3.2) 注册时提前判断手机号是否已存在checkMobile
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,checkMobile
mpstringY手机号

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 14014,
  3.     "msg": "account is exist"
  4. }
复制代码


3.3) 变更绑定手机号时提前判断是否重复或已存在checkNewMobile
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,checkNewMobile
mpstringY手机号

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 14032,
  3.     "msg": "same mobile"
  4. }
复制代码


3.4) 变更绑定邮箱时提前判断是否重复或已存在checkEmail
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,checkEmail
emailstringY电子邮箱

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 14068,
  3.     "msg": "same email"
  4. }
复制代码


3.5) 获取邮件验证码getMailCode
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,getMailCode
emailstringY邮箱地址
typestringY获取类型:绑定bind,会直接发送连接到邮箱点击链接即可激活;解绑unbind,会发送6位验证码到邮箱,需填写到APP方可提交下一步

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


4) 设置头像setAvatar
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,setAvatar
avatarstringY头像文件jpeg,jpg,png,gif,bmp

返回参数说明:
名称 类型 说明
codeint返回码,更新成功请更新APP登录信息文件中对应的头像
msgstring返回信息
datastring头像网址

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data":"http://www.pmsdev.com/user/images/avatar.gif"
  5. }
复制代码


5) 修改密码changePwd
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,changePwd
oldpasswordstringY旧密码
newpasswordstringY新密码
comfirmpasswordstringY确认新密码

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


6) 安全问题
6.1) 加载安全问题loadQuestions
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,loadQuestions

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息
dataarray返回信息
data:itemsarray返回数据集

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "1": "母亲的名字",
  5.         "2": "爷爷的名字",
  6.         "3": "父亲出生的城市",
  7.         "4": "您最尊敬的老师的名字",
  8.         "5": "您最喜欢的餐馆名称",
  9.         "6": "您的驾驶证后四位数字"
  10.     }
  11. }
复制代码


6.2) 修改安全问题updateSQ
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,updateSQ
oldquestionintY/N选择旧安全问题,登录信息中返回的safe_question=0时不必
oldanswerstringY/N填写旧安全问题答案,登录信息中返回的safe_question=0时不必
newquestionintY选择新的安全问题
newanswerstringY填写新的安全问题答案

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的安全问题数值
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


7) 修改用户资料modifyInfo
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,modifyInfo
nicknamestringN昵称,为空自动使用登录账号做昵称
sexintN默认为0:0保密;1男;2女
birthdaystringY时间格式2012-8-24
secret_switchintN保密设置,默认0:0完全保密;1朋友可见;2通用开放;3完全开放

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的sex、nickname、secret_switch
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


8) 找回密码
8.1) 找回第一步findPwd
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,findPwd
mpstringY手机号
smscodestringY手机短信验证码

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息
datastring返回找回码findcode,32位MD5的加密字段,APP记录并在下一步提交

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
  5. }
复制代码


8.2) 找回密码第二步,重置密码setFindPwd
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,setFindPwd
findcodestringY第一步返回的找回码
passwordstringY密码
comfirmpasswordstringY确认密码

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


9) 修改/绑定手机号bindMobile
流程说明:
后台如开启手机激活则需要同步解绑手机才可进行新手机绑定
A、开启手机激活且已绑定手机:获取并填写解绑短信验证码oldsmscode > 填写新手机号 > 获取并填写新绑定手机的短信验证码newsmscode > 提交绑定
B、开启手机激活且未绑定手机或关闭手机激活:填写新手机号 > 获取并填写新绑定手机的短信验证码newsmscode > 提交绑定

请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,bindMobile
oldsmscodestringN欲解绑的手机短信验证码
newmpstringN欲绑定的手机号
newsmscodestringY欲绑定的手机短信验证码

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的手机号
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


10) 修改/绑定邮箱bindEmail
流程说明:
后台如开启邮箱激活则需要同步解绑邮件才可进行新邮箱绑定
A、开启邮箱激活且已绑定邮箱:获取并填写解绑邮件验证码mailcode > 填写新邮箱地址 > 提交绑定,系统发送激活邮件 > 激活邮件的链接地址打开即可激活
B、开启邮箱激活且未绑定邮箱或关闭邮箱激活:填写新邮箱地址 > 提交绑定

请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,bindEmail
mailcodestringN欲解绑的邮件验证码,后台没开启邮件激活跳过
emailstringY欲绑定的邮箱地址

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的手机号
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


11) 系统消息
11.1) 获取是否有新的系统消息getExistNewMsg
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,getExistNewMsg

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的手机号
msgstring返回信息
dataint返回条数

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": 5
  5. }
复制代码


11.2) 获取系统消息getMessage,每加载一页默认把加载的这些消息标注已读
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,getMessage
pagesizeintN每页加载条数,默认10条
pageintN加载页码,默认第1页

返回参数说明:
名称 类型 说明
codeint返回码,绑定成功请更新APP登录信息文件中对应的手机号
msgstring返回信息
dataarray返回数据
data : totalint数据总条数
data : pagesizeint数据每页条数
data : pagesint数据总页数
data : pageint数据当前页码
data : itemsarray数据集
data : items : idint消息ID
data : items : is_systembool是否系统消息
data : items : is_readbool是否已读
data : items : titlestring消息标题
data : items : timestring消息发布时间
data : items : user_idint非系统消息时的发送方user_id,根据系统设置考虑
data : items : user_id_accountstring非系统消息时的发送方user_account,根据系统设置考虑

JSON返回示例:
  1. {
  2.     "data": {
  3.         "total": 1,
  4.         "pagesize": 10,
  5.         "pages": 1,
  6.         "page": 1,
  7.         "items": [
  8.             {
  9.                 "id": 1,
  10.                 "is_system": false,
  11.                 "is_read": false,
  12.                 "title": "您的会员帐号已成功绑定邮箱",
  13.                 "time": "1468297233",
  14.                 "user_id": 0,
  15.                 "user_id_account": ""
  16.             }
  17.         ]
  18.     },
  19.     "code": 200,
  20.     "msg": "success"
  21. }
复制代码


12) 获取用户信息getProfle
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,getProfle

返回参数说明:
名称 类型 说明
uidint用户的user_id
accountstring登录账号
avatarstring头像网址
nicknamestring昵称
sexint性别:0保密;1男;2女
locatedstring地区,有值时显示格式如:福建 莆田
birthdaystring时间戳,需自行格式化为date类型
emailstring邮箱地址
email_verifiedint是否已绑定,0未绑;1已绑。绑定过的可以用邮箱登录,修改绑定邮箱时需验证旧邮件验证码
mpstring手机号
mp_verifiedint是否已绑定,0未绑;1已绑。绑定过的可以用手机号登录,修改绑定手机时需验证旧手机验证码
secret_switchint保密设置:0完全保密;1朋友可见;2通用开放;3完全开放
safe_questionint安全问题数值,用于修改安全问题时是否需要显示并验证原问题答案用

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "uid": 1,
  5.         "account": "arsio",
  6.         "avatar": "http://www.pmsdev.com/user/images/avatar.gif",
  7.         "nickname": "arsio",
  8.         "sex": 0,
  9.         "located": "",
  10.         "birthday": "0",
  11.         "email": "",
  12.         "email_verified": 0,
  13.         "mp": "",
  14.         "mp_verified": 0,
  15.         "secret_switch": 2,
  16.         "safe_question": 0
  17.     },
  18.     "msg": "success"
  19. }
复制代码


13) 注销登录logout
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,用户模块为user
actstringY 函数名,logout

返回参数说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4. }
复制代码

开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-5-29 18:27:45 | 显示全部楼层
· 用户圈子

1) APP朋友圈
1.1) 获取APP朋友圈内容
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,getMomentList
oidintN已加载的最新的一篇圈子时刻内容,为空则自动获取最后一次登录的时间点和刷新断点纪录做加载条件
bidintN上提加载下一页可选,无bid则传递oid,bid的定义为刷新加载时存在多页,返回一页内容会追加一个break id(bid)作为分页加载的起始ID
nextintN上提加载下一页时必需,传递值为1
ownintN加载自己发布到朋友圈的内容时必须传递own,且值为1

获取APP朋友圈内容getMomentList返回参数data下字段说明:
名称 类型 说明
data array数据
data : totalint本次获取新内容总条数
data : bidint本次加载的断点ID,用于加载下一页
data : itemsarray本次加载的圈时刻内容数组(字典)
data : items : idint圈时刻ID
data : itmes : descriptionstring圈时刻文本内容
data : itmes : typeint圈时刻类型:1相册;2小视频;3连接
data : itmes : linkstring类型为3的外链地址
data : itmes : accountstring所属原始账号,需从好友列表里获取头像和昵称等
data : itmes : timeint发布时间戳
data : itmes : timestrstring发布时间格式,如3分钟前
data : itmes : locatedstring发布位置名称
data : itmes : attachmentsarray附件原地址,数组
data : itmes : attachthumbsarray附件缩略图,单张时长宽不固定,最长/宽不超过200
data : itmes : diggint可视点赞数量,后台关闭时不显示
data : itmes : diggsarray点赞列表,后台关闭时不显示
data : itmes : commentint可视评论数量,后台关闭时不显示
data : itmes : commentsarray评论列表,后台关闭时不显示
data : itmes : diggs : totalint可视点赞数量
data : itmes : diggs : itemsarray可视点赞信息
data : itmes : diggs : items : idint点赞ID
data : itmes : diggs : items : diggerstring点赞人原始账号,需从好友列表里获取头像和昵称信息
data : itmes : diggs : timeint点赞时间戳
data : itmes : comments : totalint可视评论数量
data : itmes : comments : itemsarray可视评论信息
data : itmes : comments : items : idint评论ID
data : itmes : comments : items : commenterstring评论人原始账号,需从好友列表里获取头像和昵称信息
data : itmes : comments : items : atwhoint评论回复谁的原始账号,需从好友列表里获取头像和昵称信息
data : itmes : comments : items : contentstring评论内容
data : itmes : comments : items : timeint评论时间戳

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "bid": 12345,
  5.         "total": 2,
  6.         "items": [
  7.             {
  8.                 "id": 12346,
  9.                 "description": "原来CC的同时还进行了SYN攻击……",
  10.                 "type": 1,
  11.                 "attachments": [
  12.                     "http://www.pmsdev.com/data/plugins/modules/moment/12345678910111214.jpg",
  13.                     "http://www.pmsdev.com/data/plugins/modules/moment/12345678910111215.jpg"
  14.                 ],
  15.                 "attachthumbs": [
  16.                     "http://www.pmsdev.com/data/plugins/modules/moment/thumb/12345678910111214.jpg",
  17.                     "http://www.pmsdev.com/data/plugins/modules/moment/thumb/12345678910111215.jpg"
  18.                 ],
  19.                 "diggs": {
  20.                     "total": 0,
  21.                     "items": []
  22.                 },
  23.                 "digg": 0,
  24.                 "comments": {
  25.                     "total": 0,
  26.                     "items": []
  27.                 },
  28.                 "comment": 0,
  29.                 "link": "",
  30.                 "account": "arsio",
  31.                 "time": "1468132042",
  32.                 "timestr": "2小时前",
  33.                 "located": "莆田·蔚图"
  34.             },
  35.             {
  36.                 "id": 12345,
  37.                 "description": "服务器被人CC攻击真心不爽",
  38.                 "type": 1,
  39.                 "attachments": [
  40.                     "http://www.pmsdev.com/data/plugins/modules/moment/12345678910111213.jpg"
  41.                 ],
  42.                 "attachthumbs": [
  43.                     "http://www.pmsdev.com/data/plugins/modules/moment/thumb/s_12345678910111213.jpg"
  44.                 ],
  45.                 "diggs": {
  46.                     "total": 2,
  47.                     "items": [
  48.                         {
  49.                             "id": 1,
  50.                             "digger": "vtoo",
  51.                             "time": "1789999999"
  52.                         },
  53.                         {
  54.                             "id": 2,
  55.                             "digger": "youki",
  56.                             "time": "1790000000"
  57.                         }
  58.                     ]
  59.                 },
  60.                 "digg": 2,
  61.                 "comments": {
  62.                     "total": 3,
  63.                     "items": [
  64.                         {
  65.                             "id": 1,
  66.                             "commenter": "vtoo",
  67.                             "atwho": "",
  68.                             "content": "别发牢骚了,抓紧解决!",
  69.                             "time": "1468143042"
  70.                         },
  71.                         {
  72.                             "id": 2,
  73.                             "commenter": "arsio",
  74.                             "atwho": "vtoo",
  75.                             "content": "CC解决了,正在解决SYN",
  76.                             "time": "1468147042"
  77.                         },
  78.                         {
  79.                             "id": 3,
  80.                             "commenter": "youki",
  81.                             "atwho": "",
  82.                             "content": "解决了就好~",
  83.                             "time": "1468151042"
  84.                         }
  85.                     ]
  86.                 },
  87.                 "comment": 2,
  88.                 "link": "",
  89.                 "account": "arsio",
  90.                 "time": "1468131042",
  91.                 "timestr": "2小时前",
  92.                 "located": "莆田·荔园小区"
  93.             }
  94.         ]
  95.     },
  96.     "msg": "success"
  97. }
复制代码


1.2) 获取圈时刻详情
请求参数说明:
名称类型必填说明
keystringY APP生成并记录到服务器的唯一的key值
mstringY模块名称,圈子模块为moment
actstringY函数名,获取内容getMomentDetail
midintY圈时刻ID

获取列表getMomentDetail返回参数说明:
名称类型说明
itemsarray数据
items : idint视频ID
items : descriptionstring描述
items : typeint类型:1相册;2短视频;3链接
items : attachmentsarray附件原地址
items : attachthumbsarray附件缩略图,短视频无缩略图,单图时尺寸不是1:1
items : diggsarray可见的点赞数据集
items : diggs : totalint可见的点赞数据数
items : diggs : itemsarray可见的点赞数据
items : diggs : items : idint点赞ID
items : diggs : items : diggerstring点赞人原始账号
items : diggs : items : timestring点赞时间戳
items : diggint可见的点赞数据数
items : commentsarray可见的点赞数据集
items : comments : totalarray可见评论数
items : comments : itemsarray可见的评论数据
items : comments : items : idint评论ID
items : comments : items : commenterstring评论人原始账号
items : comments : items : atwhostring@回复谁
items : comments : items : contentstring评论内容
items : comments : items : timestring评论时间戳
items : commentint可见评论数
items : linkstring外链链接,待定
items : accountstring发布人原始账号
items : timestring发布时间时间戳
items : timestrstring发布时间时间格式串
items : adidstring广告ID
items : adidextstring替代广告ID
items : locatedstring自定义或自动获取位置名称

JSON返回示例:
  1. {
  2.     "data": {
  3.         "items": {
  4.             "id": 12345,
  5.             "description": "服务器被人CC攻击真心不爽",
  6.             "type": 1,
  7.             "attachments": [
  8.                 "http://www.pmsdev.com/data/plugins/modules/moment/12345678910111213.jpg"
  9.             ],
  10.             "attachthumbs": [
  11.                 "http://www.pmsdev.com/data/plugins/modules/moment/thumb/12345678910111213.jpg"
  12.             ],
  13.             "diggs": {
  14.                 "total": 2,
  15.                 "items": [
  16.                     {
  17.                         "id": 1,
  18.                         "digger": "vtoo",
  19.                         "time": "1789999999"
  20.                     },
  21.                     {
  22.                         "id": 2,
  23.                         "digger": "youki",
  24.                         "time": "1790000000"
  25.                     }
  26.                 ]
  27.             },
  28.             "digg": 2,
  29.             "comments": {
  30.                 "total": 3,
  31.                 "items": [
  32.                     {
  33.                         "id": 1,
  34.                         "commenter": "vtoo",
  35.                         "atwho": "",
  36.                         "content": "别发牢骚了,抓紧解决!",
  37.                         "time": "1468143042"
  38.                     },
  39.                     {
  40.                         "id": 2,
  41.                         "commenter": "arsio",
  42.                         "atwho": "vtoo",
  43.                         "content": "CC解决了,正在解决SYN",
  44.                         "time": "1468147042"
  45.                     },
  46.                     {
  47.                         "id": 3,
  48.                         "commenter": "youki",
  49.                         "atwho": "",
  50.                         "content": "解决了就好~",
  51.                         "time": "1468151042"
  52.                     }
  53.                 ]
  54.             },
  55.             "comment": 2,
  56.             "link": "http://www.pmsdev.com/moment.php?mid=12345",
  57.             "account": "arsio",
  58.             "time": "1468131042",
  59.             "timestr": "4小时前",
  60.             "adid": "",
  61.             "adidext": "",
  62.             "located": "莆田·荔园小区"
  63.         }
  64.     },
  65.     "code": 200,
  66.     "msg": "success"
  67. }
复制代码

1.3) 发布APP朋友圈内容
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,writeMoment
typeintY内容类型
descriptionstringN圈时刻内容,不能与附件或链接同时为空
photoarrayN类型为1相册的附件
videostringY|N类型为2短视频时的附件
linkstringY|N圈时刻内容ID
statuintN圈时刻内容隐私设置:0公开;1私密;2部分可见;3不给谁看
filterarrayY|N隐私设置为部分可见时必填,好友原始账号
shieldarrayY|N隐私设置为不给谁看时必填,好友原始账号
remindarrayN提醒谁看,好友原始账号
latitudeintY位置坐标经度
longitudeintY位置坐标维度
precisionintY位置坐标精度
locatedstringN位置备注

发布APP朋友圈内容writeMoment返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


2) 圈时刻点赞相关
2.1) 获取APP朋友圈内容的点赞信息,用于对缓存圈时刻信息更新点赞信息
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,getMomentDigg
midintY圈时刻内容ID
odidintN当前内容的旧的最新点赞ID

获取APP朋友圈内容的点赞信息getMomentDigg返回参数data下字段说明:
名称 类型 说明
data array数据
data : totalint本次获取新内容总条数
data : itemsarray本次加载的圈时刻内容数组(字典)
data : itmes : idint点赞ID
data : itmes : diggerstring点赞人原始账号,需从好友列表里获取头像和昵称信息
data : itmes : timeint点赞时间戳

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 2,
  5.         "items": [
  6.             {
  7.                 "id": 1,
  8.                 "digger": "vtoo",
  9.                 "time": "1789999999"
  10.             },
  11.             {
  12.                 "id": 2,
  13.                 "digger": "youki",
  14.                 "time": "1790000000"
  15.             }
  16.         ]
  17.     },
  18.     "msg": "success"
  19. }
复制代码


2.2) 为APP朋友圈内容点赞
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,diggMoment
midintY圈时刻内容ID

为APP朋友圈内容点赞diggMoment返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


3) 圈时刻评论相关
3.1) 获取APP朋友圈内容的评论信息,用于对缓存圈时刻信息更新评论信息
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,getMomentComment
midintY圈时刻内容ID
ocidintN当前内容的旧的最新评论ID

获取APP朋友圈内容的点赞信息getMomentComment返回参数data下字段说明:
名称 类型 说明
data array数据
data : totalint本次获取新内容总条数
data : itemsarray本次加载的圈时刻内容数组(字典)
data : items : idint评论ID
data : items : commenterstring评论人原始账号
data : items : atwhostring@回复谁
data : items : contentstring评论内容
data : items : timestring评论时间戳

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 2,
  5.         "items": [
  6.             {
  7.                 "id": 2,
  8.                 "commenter": "arsio",
  9.                 "atwho": "vtoo",
  10.                 "content": "CC解决了,正在解决SYN",
  11.                 "time": "1468147042"
  12.             },
  13.             {
  14.                 "id": 3,
  15.                 "commenter": "youki",
  16.                 "atwho": "",
  17.                 "content": "解决了就好~",
  18.                 "time": "1468151042"
  19.             }
  20.         ]
  21.     },
  22.     "msg": "success"
  23. }
复制代码


3.2) 评论APP朋友圈内容
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,commentMoment
midintY圈时刻内容ID
replystringY回复谁的评论,即@谁
contentstringY评论内容

为APP朋友圈内容点赞diggMoment返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


4) 圈子设置项
3.1) 获取APP朋友圈设置
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,getMomentSetting

获取APP朋友圈设置getMomentSetting返回参数data下字段说明:
名称 类型 说明
data array数据
data : user_accountstring设置所有人原始账号
data : setting_backgroundstring圈封面图片
data : setting_signstring圈签名
data : setting_newint更新提醒
data : setting_tagsarray标签
data : setting_filterarray不看TA的
data : setting_shieldarray不给TA看
data : setting_strangerint给陌生人查看
data : setting_idint设置的ID

JSON返回示例:
  1. {
  2.     "data": {
  3.         "user_account": "arsio",
  4.         "setting_background": "",
  5.         "setting_sign": "",
  6.         "setting_new": 1,
  7.         "setting_tags": [],
  8.         "setting_filter": [],
  9.         "setting_shield": [],
  10.         "setting_stranger": 1,
  11.         "setting_id": 0
  12.     },
  13.     "code": 200,
  14.     "msg": "success"
  15. }
复制代码


3.2) 配置APP朋友圈设置
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为moment
actstringY 函数名,momentSetting
typestringY配置字段类型:bg、sign、new、stranger、tags、filter、shield
bgstringY|N背景封面图,类型为bg时必传,其他值不传
signstringY|N签名,文字长度不超30个字,类型为sign时必传,其他值不传
newintY|N是否更新提醒,类型为new时必传,其他值不传
strangerintY|N陌生人是否可预览,类型为stranger时必传,其他值不传
tagsarrayY|N标签,类型为tags时必传,其他值不传
filterarrayY|N不看TA的,类型为filter时必传,其他值不传
shieldarrayY|N不让TA看,类型为shield时必传,其他值不传

配置APP朋友圈设置momentSetting返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息
datastring类型为bg时才会返回该项图片WEB端地址

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码

开企网络动力·构筑蔚蓝图腾

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-6-5 22:56:31 | 显示全部楼层
· 好友

1 获取APP好友列表,包含单双向好友,不包含未建立好友关系的好友
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,getFriends
allintN值为1时获取全部好友,为0或空或false则分页加载
pagesizeintN每加载一页个数,all为1时无效,为空根据后台设置
pageintN加载页码,all为1时无效

获取APP好友列表getFriends返回参数data下字段说明:
名称 类型 说明
data array数据
data : totalint好友总数
data : pagesint非获取全部好友时的总页数,获取全部时无效
data : curpageint非获取全部好友时的当前页码,获取全部时无效
data : pagesizeint非获取全部好友时的每页加载个数,获取全部时无效
data : itemsarray本次加载的好友数据数组(字典)
data : items : idint好友ID(并非好友的用户ID)
data : itmes : accountstring好友的原始账号
data : itmes : nicknamestring好友的昵称
data : itmes : avatarstring好友的头像
data : itmes : markstring好友的备注名称,后台开启备注才有此项
data : itmes : tagsarray好友的标签,后台开启标签才有此项
data : itmes : focusint是否星标好友:1是;0不是

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 1,
  5.         "items": [
  6.             {
  7.                 "id": 1,
  8.                 "account": "vtoo",
  9.                 "nickname": null,
  10.                 "avatar": "http://www.pmsdev.com/",
  11.                 "mark": "",
  12.                 "tags": [],
  13.                 "focus": 0
  14.             }
  15.         ]
  16.     },
  17.     "msg": "success"
  18. }
复制代码


2 获取有效好友
有效好友的定义:不在各自黑名单、不在好友不让看列表、不在自己不给看列表、未互加好友
请求参数说明:
名称类型必填说明
keystringY APP生成并记录到服务器的唯一的key值
mstringY模块名称,好友模块为friend
actstringY函数名,获取内容getActiveFriends

获取列表getActiveFriends返回参数说明:
名称类型说明
codeint返回码
msgstring返回码对应信息
dataarray有效好友数据数组

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         "vtoo",
  5.         "youki"
  6.     ],
  7.     "msg": "success"
  8. }
复制代码


3 获取好友信息
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,getFriendInfo
friendstringY好友的原始账号

发布APP朋友圈内容getFriendInfo返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息
dataarray返回数据集
data : idint好友ID,非用户ID
data : accountstring好友原始账号
data : nicknamestring好友昵称
data : tagsarray好友标签
data : markstring好友备注名称
data : descriptionstring好友备注信息
data : statuint是否列为黑名单,1正常,0黑名单
data : focusint是否星标,1为是
data : filterint1不看他的
data : shieldint1不给他看
data : isdeniedint1被屏蔽无权查看,0正常状态
data : ismutualint1双向好友,0单向好友

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "id": 1,
  5.         "account": "vtoo",
  6.         "nickname": "Vtoo Network",
  7.         "tags": [],
  8.         "mark": "",
  9.         "description": "",
  10.         "statu": 1,
  11.         "focus": 0,
  12.         "filter": 0,
  13.         "shield": 0,
  14.         "isdenied": 0,
  15.         "ismutual": 1
  16.     },
  17.     "msg": "success"
  18. }
复制代码


4 更新好友资料
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,updateFriend
friendstringY好友原始账号
fieldstringY所更新的项:info资料含备注名称、备注信息、备注电话;statu是否列入黑名单;
focus是否设为星标;filter是否不看他的;shield是否不给他看
markstringNfield为info时必传:备注名称
descriptionstringNfield为info时必传:备注信息
phonestringNfield为info时必传:备注电话
statuintNfield为statu时必传:0黑名单;1正常
focusintNfield为focus时必传:1星标;0非星标
filterintNfield为focus时必传:1不看他的;0正常
shieldintNfield为shield时必传:1不给他看;0正常
tagsstringNfield为tags时必传,标签

获取APP朋友圈内容的点赞信息updateFriend返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


5 搜索好友
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,findFriend
friendstringY原始账号、手机号,不支持泛搜索

搜索好友findFriend返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息
dataarray返回数据集
data : accountstring原始账号
data : nicknamestring昵称
data : sexint性别:0保密;1男;2女
data : avatarstring头像地址
data : mpstring手机号码,仅搜索的为手机号时才有值

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "account": "vtoo",
  6.             "nickname": "Vtoo Network",
  7.             "sex": 1,
  8.             "avatar": "",
  9.             "mp": ""
  10.         }
  11.     ],
  12.     "msg": "success"
  13. }
复制代码


6 添加好友
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,addFriend
referrerstringN推荐人,仅通过推荐信息添加的时候传递
accountstringY欲加好友的原始账号
notestringN申请验证信息
shieldintN不让他看

添加好友addFriend返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


7 推荐好友
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,referFriend
friendstringY接收名片的好友原始账号
accountstringY好友名片原始账号

为APP朋友圈内容点赞referFriend返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码


8 处理好友请求
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,好友模块为friend
actstringY 函数名,replyRequire
friendstringY接收名片的好友原始账号
replyintY处理动作:1屏蔽;2拒绝;3忽略;5成功

处理好友请求replyRequire返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码
开企网络动力·构筑蔚蓝图腾
回复 支持 反对

使用道具 举报

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-6-5 22:56:56 | 显示全部楼层
· 评论

1 获取评论信息
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为comment
actstringY 函数名,getCommentList
cidintY频道ID
didintY内容ID
pagesizeintN每页数量
pageintN页码

获取评论信息getCommentList返回参数data下字段说明:
名称 类型 说明
data array数据
data : totalint本次获取新内容总条数
data : itemsarray本次加载的圈时刻内容数组(字典)
data : items : idint评论ID
data : items : commenterstring评论人原始账号
data : items : atwhostring@回复谁
data : items : contentstring评论内容
data : items : timestring评论时间戳

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "total": 2,
  5.         "pages": 1,
  6.         "curpage": 1,
  7.         "pagesize": 10,
  8.         "items": [
  9.             {
  10.                 "id": 3,
  11.                 "user": 1,
  12.                 "user_nickname": "arsio",
  13.                 "user_avatar": "http://www.pmsdev.com/statics/images/avatar-comment.png",
  14.                 "reply": 2,
  15.                 "reply_nickname": "Vtoo Network",
  16.                 "content": "凑足15个字,凑足15个字,凑足15个字",
  17.                 "time": "1468263267"
  18.             },
  19.             {
  20.                 "id": 2,
  21.                 "user": 2,
  22.                 "user_nickname": "Vtoo Network",
  23.                 "user_avatar": "http://www.pmsdev.com/statics/images/avatar-comment.png",
  24.                 "reply": 0,
  25.                 "reply_nickname": "",
  26.                 "content": "凑足15个字,凑足15个字,凑足15个字",
  27.                 "time": "1468263232"
  28.             }
  29.         ]
  30.     },
  31.     "msg": "success"
  32. }
复制代码


2 写评论
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstring Y 模块名称,圈子模块为comment
actstringY 函数名,writeComment
cidintY频道ID
didintY内容ID
replyintY回复谁的评论:ID
contentstringY评论内容

写评论writeComment返回参数data下字段说明:
名称 类型 说明
codeint返回码
msgstring返回码对应信息
datastring评论审核时返回wait,评论不审核不返回

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "wait": true
  6.     }
复制代码
开企网络动力·构筑蔚蓝图腾
回复 支持 反对

使用道具 举报

35

主题

59

帖子

444

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
444
QQ
 楼主| 发表于 2016-6-5 22:57:23 | 显示全部楼层
· APP系统设置

1 注册设备
第一次运行APP是需要注册设备,生成KEY及下载基本配置信息,再保存到APP下但基本配置文件
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,regDevice
uuidstringY设备的UUID或者由设备网卡MAC或其他硬件设备地址+随机码/时间戳生成一个UUID,最大长度36
versionstringY版本号,系统类型自动获取
devicestringY设备名称

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
data array返回数据集
data : keystring注册设备KEY用于后续操作
data : configarray系统配置集
data : config : keystring系统配置键
data : config : titlestring系统配置标题
data : config : valuestring系统配置值
data : switcharray系统配置的开关

JSON返回示例:
  1. {
  2.     "data": {
  3.         "key": "3afeb2ff37cad3d5df2f16975208339e",
  4.         "config": [
  5.             {
  6.                 "key": "app_title",
  7.                 "title": "APP名称",
  8.                 "value": "PMS APP"
  9.             },
  10.             {
  11.                 "key": "app_logo",
  12.                 "title": "APP标志",
  13.                 "value": ""
  14.             },
  15.             {
  16.                 "key": "app_terms",
  17.                 "title": "使用条款",
  18.                 "value": ""
  19.             },
  20.             {
  21.                 "key": "app_copyright",
  22.                 "title": "版权所有",
  23.                 "value": "蔚图网络"
  24.             },
  25.             {
  26.                 "key": "app_btminfo",
  27.                 "title": "底部信息",
  28.                 "value": "Copyright © 2016 PMSDev."
  29.             },
  30.             {
  31.                 "key": "app_support",
  32.                 "title": "技术支持",
  33.                 "value": "Vtoo Network Inc."
  34.             },
  35.             {
  36.                 "key": "about_title",
  37.                 "title": "关于我们标题",
  38.                 "value": "莆田市蔚图网络有限公司"
  39.             },
  40.             {
  41.                 "key": "about_intro",
  42.                 "title": "关于我们内容",
  43.                 "value": "莆田市蔚图网络有限公司致力于企业及机构网络市场开拓服务,是一家年轻有活力的网络公司。秉持“开企网络动力·构筑蔚蓝图腾”的企业理念,为各行业企业及机构提供定制化的网络化布局、电子商务网络全面解决方案。服务领域涵盖网站建设、主机域名服务、SEO推广、二次开发、微信运营、APP软件开发、网络布局等周边服务。"
  44.             },
  45.             {
  46.                 "key": "developer_title",
  47.                 "title": "开发者标题",
  48.                 "value": "莆田市蔚图网络有限公司"
  49.             },
  50.             {
  51.                 "key": "developer_intro",
  52.                 "title": "开发者介绍",
  53.                 "value": "莆田市蔚图网络有限公司致力于企业及机构网络市场开拓服务,是一家年轻有活力的网络公司。秉持“开企网络动力·构筑蔚蓝图腾”的企业理念,为各行业企业及机构提供定制化的网络化布局、电子商务网络全面解决方案。服务领域涵盖网站建设、主机域名服务、SEO推广、二次开发、微信运营、APP软件开发、网络布局等周边服务。"
  54.             },
  55.             {
  56.                 "key": "ios_filter_version",
  57.                 "title": "iOS审核版本",
  58.                 "value": ""
  59.             }
  60.         ],
  61.         "switch": {
  62.             "sms_switch": 1,
  63.             "sms_switch_remind_owner": 0,
  64.             "mail_switch": 1,
  65.             "mail_switch_remind_owner": 0,
  66.             "user_switch": 1,
  67.             "user_switch_msg": 1,
  68.             "user_switch_register": 1,
  69.             "user_switch_active": 0,
  70.             "user_switch_active_email": 0,
  71.             "user_switch_active_mp": 1,
  72.             "user_switch_verify_avatar": 0,
  73.             "user_switch_sms_login": 0,
  74.             "user_switch_sms_find": 0,
  75.             "user_switch_mail_find": 0,
  76.             "user_switch_code_type": 0,
  77.             "wap_switch": 1,
  78.             "friend_switch": 1,
  79.             "friend_switch_tags": 0,
  80.             "friend_switch_mark": 0,
  81.             "moment_switch": 1,
  82.             "moment_switch_digg": 1,
  83.             "moment_switch_comment": 1,
  84.             "moment_switch_setting": 1,
  85.             "app_switch": 1,
  86.             "app_verify_switch": 1,
  87.             "comment_switch": 1,
  88.             "comment_switch_moderation": 1
  89.         }
  90.     },
  91.     "code": 200,
  92.     "msg": "success"
  93. }
复制代码


2 验证设备
非第一次运行APP后每重新打开APP时需要验证设备信息,如登录过账号则可自动续期,账号再别处登录则需要重新登录
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,checkDevice
uuidstringY首次运行APP后保存的UUID
versionstringY版本号,系统类型自动获取

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
databooltrue是与false否

JSON返回示例:
  1. {
  2.     "data": true,
  3.     "code": 200,
  4.     "msg": "success"
  5. }
复制代码


3 检查新版本
注册过的设备会自动获取当前版本,故无需传输version
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,checkVersion

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
databooltrue存在新版本;false无新版

JSON返回示例:
  1. {
  2.     "data": false,
  3.     "code": 200,
  4.     "msg": "success"
  5. }
复制代码


4 获取版本列表
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,getVersionList
pagestringN页码,默认1

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
data array返回数据集
data : totalint总数据条数
data : pagesizeint每页数据条数
data : curpageint当前页码
data : pagesint总页数
data : itemsarray版本数据
data : items : idint版本ID
data : items : internalint是否内测版本,1是
data : items : titlestring版本标题
data : items : nostring版本号
data : items : timestring发布时间

JSON返回示例:
  1. {
  2.     "data": {
  3.         "total": 1,
  4.         "pagesize": 10,
  5.         "curpage": 1,
  6.         "pages": 1,
  7.         "items": [
  8.             {
  9.                 "id": 1,
  10.                 "internal": 0,
  11.                 "title": "Windows2016新版",
  12.                 "no": "1.6.2",
  13.                 "time": "1468306938"
  14.             }
  15.         ]
  16.     },
  17.     "code": 200,
  18.     "msg": "success"
  19. }
复制代码


5 获取版本详情
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,getVersionDetail
idstringY版本ID

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
data array返回数据
data : idint版本ID
data : internalint是否内测版本,1是
data : titlestring版本标题
data : nostring版本号
data : introstring版本说明
data : updatestring更新说明
data : pathstring下载地址
data : timestring发布时间

JSON返回示例:
  1. {
  2.     "data": {
  3.         "items": {
  4.             "id": 1,
  5.             "internal": 0,
  6.             "title": "Windows2016新版",
  7.             "no": "1.6.2",
  8.             "intro": "更多功能、更多趣味",
  9.             "update": "更新新功能和修复部分补丁",
  10.             "path": "http://www.pmsdev.com/data/plugins/extends/app/version/windows2016.exe",
  11.             "time": "1468306938"
  12.         }
  13.     },
  14.     "code": 200,
  15.     "msg": "success"
  16. }
复制代码


6 自动登录检测
如果有用账号登录过,则直接验证token登录
请求参数说明:
名称 类型 必填 说明
keystring Y APP生成并记录到服务器的唯一的key值
mstringY 模块名称,APP模块为app
actstringY 函数名,checkToken
tokenstringY登录记录的TOKEN值

返回参数说明:
名称 类型 说明
code int返回码
msg int返回信息
databooltrue成功自动续期;false需重新登录

JSON返回示例:
  1. {
  2.     "code": 200,
  3.     "msg": "success"
  4. }
复制代码

开企网络动力·构筑蔚蓝图腾
回复 支持 反对

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

QQ|小黑屋|手机版|Archiver|蔚图VTOO ( 闽ICP备13006947号 )

GMT+8, 2024-12-14 21:49 , Processed in 0.185011 second(s), 8 queries , File On.

Powered by Discuz! X3.4

Copyright © 2001-2021, Tencent Cloud.

快速回复 返回顶部 返回列表