设备控制

设备控制指令

设备控制接口指令功能包括设备禁用/解禁、设备恢复出厂设置、设备重启、应用白名单、应用部署、应用卸载、系统升级、消息提醒、开启远程服务、上报设备信息、设备上传日志。

接口地址:/api/device/deviceOperation

content-type：application/json
method：post

传入参数

属性	类型	默认值	必填	说明
code	string		是	iot管理平台中获取到的code值
deviceSn	string		是	设备sn（与机型id集合2选1必传）
deviceTypes	int[]		是	机型id集合（与机型id集合2选1必传）获取设备类型接口
common	int		是	具体操作命令码
data	string		是	操作数据 将object转为json字符串传入

common指令码及其对应dataObject

• 设备禁用：1001

{
	"common": 1001,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 设备解禁：1002

属性	类型	默认值	必填	说明
remark	string		否	消息提示

{
	"common": 1002,
	"deviceSn": "",
	"data": "{"remark":"消息提示"}",
	"deviceTypes": [],
	"code": ""
}

• 恢复出厂设置：1004

{
	"common": 1004,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 设备重启：1005

{
	"common": 1005,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 上报设备信息：5003

{
	"common": 5003,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 开启远程服务：5000

{
	"common": 5000,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 设备上传日志：3010

{
	"common": 3010,
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

• 应用白名单：3001

属性	类型	默认值	必填	说明
whiteList	list		是	应用白名单集合

集合内object数据

属性	类型	默认值	必填	说明
appName	string		是	应用名称
appPackage	string		是	应用包名
appSignature	string		否	应用签名

注：

传入一个空的whiteList集合 就会设置为不限制应用安装

{
	"common": 3005,
	"deviceSn": "",
	"data": "{"whiteList": []}",
	"deviceTypes": [],
	"code": ""
}

• 应用部署：3005

属性	类型	默认值	必填	说明
apkPath	string		是	应用下载url
appName	string		是	应用名称
installType	int		是	安装方式 1：通知用户更新，2：静默安装
immediately	int		是	安装时机：0：立刻安装 1：定时安装
installTime	string		否	定时安装时间 不可小于当前时间 格式：yyyy-MM-dd HH:mm:ss

{
	"common": 3005,
	"deviceSn": "",
	"data": "{"apkPath":"应用下载url", "appName":"应用名称", "installType": 1, "immediately": 0}",
	"deviceTypes": [],
	"code": ""
}

• 应用卸载：3002

属性	类型	默认值	必填	说明
list	list		是	卸载应用集合

集合内object数据

属性	类型	默认值	必填	说明
appName	stirng		是	应用名称
appPackage	stirng		是	应用包名

{
	"common": 3002,
	"deviceSn": "",
	"data": "{"list": []}",
	"deviceTypes": [],
	"code": ""
}

• 系统升级：1014

属性	类型	默认值	必填	说明
zipPath	stirng		是	下载url
version	stirng		是	版本号
installType	int		是	安装方式 1：通知用户更新，2：静默安装
updateDescribe	string		是	更新说明
otaType	int		是	ota方式 0：全量升级 1：差分升级
immediately	int		是	安装时机：0：立刻安装 1：定时安装
installTime	stirng		否	定时安装时间 不可小于当前时间 格式：yyyy-MM-dd HH:mm:ss

{
	"common": 3005,
	"deviceSn": "",
	"data": "{"zipPath":"应用下载url", "version":"应用名称", "installType": 1, "updateDescribe": '', "otaType": 0, "immediately": 0}",
	"deviceTypes": [],
	"code": ""
}

• 消息提醒：5002

属性	类型	默认值	必填	说明
message	stirng		是	消息内容
jumpurl	stirng		否	跳转链接

{
	"common": 0,
	"data": "{"message":"123","jumpurl":"https://iot.zhumanfang.com"}",
	"deviceSn": "",
	"deviceTypes": [],
	"code": ""
}

返回值

属性	类型	说明
code	int	返回状态码
msg	string	返回消息
data	null	返回的数据

响应示例

{
	"code": 0,
	"data": {},
	"msg": ""
}