资源描述:
《通讯助手客户端与服务器接口规范.doc》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库。
1、移动通讯助手接口规范文档文件编号:生效日期:2012年9月17日版本号:V0.1修改状态:0密级:编制:张文枫日期:2012/9/17审核:日期:批准:日期:编制者张文枫评审人员批准者移动通讯助手接口规范文档文件编号:生效日期:2012年9月17日版本号:V0.1修改状态:0密级:编制:张文枫日期:2012/9/17审核:日期:批准:日期:编制者张文枫评审人员批准者版本控制信息序号变更内容说明版本号版本日期执笔人1移动通讯助手项目接口初稿V0.12012-9-17张文枫2改动广告接口V0.22013-4-19黄珍辉3新增飞信头像批量获取接
2、口V0.32013-4-23李文平4接口act=34往后的所有接口及文档重新编号排序V0.42013-10-27魏建辉5Act=70语音己使用分钟查询2014-06-17何金烽本文档中的所有内容为福建福诺移动通信技术有限公司的机密和专属所有。未经福建福诺移动通信技术有限公司的明确书面许可,任何组织或个人不得以任何目的、任何形式及任何手段复制或传播本文档部分或全部内容。本规范解释权属福建福诺移动通信技术有限公司所有。1接口协议1.1协议说明1、接口采用Http协议的POST方式进行通信2、通信报文以JSON的格式进行传输,其编码方式为UTF
3、-8,区分大小写3、手机客户端发起Http的POST请求,服务产生应答4、特殊接口调用,采用Http协议,但格式根据实际情况而定1.2数据格式1、日期型格式:yyyyMMddHHmmss2接口规范2.1请求报文请求报文名称类型说明versionint版本号,从1开始actint调用接口编号,从1开始prmInObject输入参数fromclientString请求客户端标识0或则10=android1=ios{“version”:1,“act”:1,“fromclient”:”0”“prmIn”:{“参数名1”:“参数值1”,“参数名2”
4、:“参数值2”,…………………,…………………}}1.1应答报文应答报文名称类型说明versionint填写对应的请求报文的版本号actint填写对应的请求报文的接口编号rtnCodeint返回编码,参见附表1errString错误信息,如果执行成功,则为空,否则为错误信息描述(参见附表1的描述)prmOutObject输出参数,如果执行失败,则为空{“version”:1,“act”:1,“rtnCode”:0,“err”:“”,“prmOut”:{“参数名1”:“参数值1”,“参数名2”:“参数值2”,…………………,…………………}
5、}1接口列表1.1流量统计接口(act=1)功能描述流量统计,手机端只上传增量部分输入参数参数名类型说明phoneNoString手机号,不必填modelString机型,必填osVerString操作系统版本,必填swVerString当前软件版本,必填softwaresList软件流量列表imsiString手机卡唯一编码imeiString手机唯一编码softwares的参数pkgNameString软件包名rxLong下载流量的增量txLong上传流量的增量softNameString应用的中文名称请求报文{"version":1
6、,"act":1,"prmIn":{"phoneNo":"","model":"MotoXT531","osVer":"2.3.4","swVer":"1.0","imsi":"","imei":"","softwares":[{"pkgName":"com.funo.demo","rx":"12323","tx":"dfsfjdsljf""softName":"应用的中文名称"}]}}输出参数参数名类型说明应答报文{“version”:1,“act”:1,“rtnCode”:0,“err”:“”,“prmOut”:{}}1.1获取升级信
7、息接口(act=13)功能描述获取装机宝典升级信息输入参数参数名类型说明osString平台,参见附表2编码,必填请求报文{“version”:1,“act”:13,“prmIn”:{“os”:“1”}}输出参数参数名类型说明newVerCodeint最新版本号newVerNameString最新版本名称urlString下载地址updatedLogString更新日志应答报文{“version”:1,“act”:13,“rtnCode”:0,“err”:“”,“prmOut”:{“newVerCode”:2,“newVerName”:“
8、2.0”,“url”:“xxxx”,“updatedLog”:“xxx”}}1.1新增意见反馈接口(act=14)功能描述用户提交意见反馈输入参数参数名类型说明phoneNoString手机号