android接口与web项目对接,android端与后台webservices通讯接口规范.doc

智能手机移动监控系统

WebServices接口规范

文件状态：

[√ ] 草稿

[ ] 正式发布

[ ] 正在修改文件标识：当前版本：Version 1.0作 者：完成日期：

版 本 历 史

版本作者参与者起止日期备注Version 1.0 周平、张涵

目 录

1综述4

2名词解释4

3全局约定4

3.1接口协议4

3.2接口输入4

3.3接口输出4

3.4其它5

4接口定义5

4.1登陆接口5

4.1.1接口地址5

4.1.2接口输入5

4.1.3接口输出5

4.2总体监控6

4.2.1实时通话量统计接口6

4.2.2当前队列排队数统计接口6

4.2.3实时坐席状态统计接口7

4.2.4当日话务状态接口8

4.2.5当日服务质量指标接口8

4.2.6当日人工服务分类统计接口9

4.2.7当日各渠道服务质量接口9

4.3话务曲线10

4.3.1服务指标曲线接口10

4.3.2当日话务曲线接口11

4.3.3当月话务曲线接口12

4.4服务器监控13

4.4.1服务器运行状态13

4.4.2服务器上关键服务工作状态15

4.4.3服务器资源使用情况16

5附录17

5.1接口错误代码编码表17

综述

本文档描述了“移动平台后端支撑webservices系统”提供的数据访问接口的访问标准和相关规范，并对可能出现的重点流程进行了限定和说明。

名词解释

移动平台后端支撑webservices系统，按照远期规划，将会为android手机、android平板、iPhone、iPad/iPadMini等移动平台统一提供数据；目前，仅为特定操作系统和分辨率的android手机提供数据。

全局约定

接口协议

目前接口统一采用http协议，返回数据content type 为text/json。

接口输入

接口输入参数格式一律为：

t——数字格式字符串，时间戳，用于防止浏览器缓存

p——字符串，由JSON对象编码而来。后续接口定义中的输入参数说明，均指本JSON对象的属性。

i——数字格式字符串，流水号，用于标识请求id；该值将在输出结果中附带输出。

a——字符串，通常由登陆接口颁发，所有接口原则上均需附带该字符串作为身份验证标识符。

接口输出

接口输出即为页面的content text，其内容字符串为一个json对象。

该json对象必须具有如下两个字符串格式属性：

i——数字格式字符串，流水号，其值与本次调用时的输入参数i相同。

e——接口结果编码，0表示成功，非0表示失败。具体含义参见“附录——接口错误代码编码表”。

注：下述接口的说明中，不再对这两个属性做特别说明。

其它

所有接口均遵循REST原则。

接口定义

登陆接口

接口地址

/app/v1/logon.jsp

接口输入

参数名称参数数据类型是否可空说明u手机号不可为空用户手机号P字符串不可为空用户密码，已经经过md5加密，长度为32的字符串。r字符串不可为空随机产生的长度为6的字符串接口输出

参数名称参数数据类型是否可空说明a经过加密的字符串不可为空在用户登陆成功后按照特定算法产生的一个用户本次登陆的指纹，该指纹的特征与发起请求的手机号、发起请求时手机发送的随机字符串以及发起请求时服务端随机产生的某字符串相关。

{

“i”:”1234”,

“e”:”0”,

“a”:”12345abcd”

}

用户信息获取接口

接口地址

/app/v1/userinfo.jsp

接口输入

参数名称参数数据类型是否可空说明a经过加密的字符串不可为空由登陆接口颁发u手机号不可为空用户手机号

接口输出

参数名称参数数据类型是否可空说明scope字符串不可为空所属基地，可能的取值为South(南基地)、North(北基地)以及Both(同时具有两个基地的权限){

“i”:”1234”,

“e”:”0”,

“username”:”张三”,

“userscope”:”South|North|Both”

}

总体监控

实时通话量统计接口

接口地址

/app/v1/currCallStatus.jsp

接口输入

参数名称参数数据类型是否可空说明scope字符串不可为空所属基地，可能的取值为South(南基地)和North(北基地)

接口