通用App接口定义文档规范.docx

阅读之前〔必读*〕
。所有接口返回数据格式为
{
code:'0000'，
msg:''，data:{}
}
的形式其中code是响应码msg是响应消息默认正确响应无msg消息只有错误才有错误消息data为数据段。
Java段json格式返回
2、接口地址：/card/setHide
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
上课隐身对象
List
hideTimes
字符串
List<HideTime>
符串
json
字
HideTime{
“openState
:0
上课隐身接口
/**
*开始小时
*/
privateint
/**
startHour;
数据接口定义
*开始分钟
*/
privateint
/**
startMinute;
数据接口定义
*结束小时
*/
privateint
/**
endHour;
数据接口定义
数据接口定义
*结束分钟
*/
privateint
endMinute;
数据接口定义
数据接口定义
*模式，参考本类静态变量
*/
privateintmode
privateStringenabled;表示是否启用字符串1表示启用，0表示不启用
9。获取闹钟接口
备注
1、调用结果以json格式返回
2、接口地址:/card/getClock
输入字段定义
序号
字段名称
字段定义
数据类型
备注
数据接口定义
1
token
token
字符串
需要返回的数据
{
"count":2，
"data":[
{
"alarmsName":"起床
"openState":true，"repeatCycleMode":"012"，"time":"9:00"
}，
{
"alarmsName":"午休
"openState":false，"repeatCycleMode":"234"，
"time":"10:00"
}
]，
"code":200
"msg":成功
}
。设置闹钟接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址：/card/setClock
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
闹钟身对象List
clocks
字符串
List<Clock>json
串
字符
Clock{
"alarmsName":"起床"，
"openState":true，"repeatCycleMode":"012"，"time":"9:00"
数据接口定义
。获取一键拨号接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址：/card/getOneKey
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
Imei号
imei
Long
需要返回的数据
{
"data":［，，，，，，，，，，，］
键拨号接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址：/card/setOneKey
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
一键拨号
onekeys
字符串
4位的号码数字没有的
填0
例如：o，，o，
代笔#1为空#2#3为空#4
。设置休眠接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址：/card/setSleep
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
Imei号
imei
Long
2
是否休眠
isSleep
Boolean
是否休眠
需要返回的数据
{
数据接口定义
"code":'0000
"msg":成功
。发起远程监听接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址：/card/getRemoteMonitoring
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
类型
type
String
1代表录音
2代表回拨
3
号码
phoneNumber
String
回