抹机王API调用

帮助中心

抹机王API调用接口文档

　　抹机王提供了常用功能的API调用接口，如：一键清理、一键还原、快速添加清理应用、快速设定环境备份名等功能；

　　为方便脚本开发的调用，提供按键精灵和触动精灵的调用范例，按键范例下载，触动范例下载

一键清理-7001

功能说明：请求插件进行“一键清理”的操作；

请求地址：http://127.0.0.1:8181/api?reqCode=7001

请求参数

参数	是否必选	说明
reqCode	是	编码：7001，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"任务请求成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有清理任务在运行",
	"Data":null
}

一键还原-7002

功能说明：请求插件对指定的备份包进行还原。

请求地址：http://127.0.0.1:8181/api?reqCode=7002&configDir=/sdcard/yztc/studioplugin/wipeKing/env/xxx

请求参数

参数	是否必选	说明
reqCode	是	编号：7002，接口请求码
configDir	是	备份环境路径，可由一键清理时返回获取，或者用户自定义拷贝的环境路径（值为：deviceInfo.xml的父目录）

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"一键还原成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有任务在运行",
	"Data":null
}

一键备份环境数据-7003

功能说明：请求插件对当前环境进行备份。

请求地址：http://127.0.0.1:8181/api?reqCode=7003

注意：需配合7011进行组合使用

请求参数

参数	是否必选	说明
reqCode	是	编码：7003，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"任务请求成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有备份任务在运行",
	"Data":null
}

一键还原上个环境-7004

功能说明：请求插件还原上一个环境。非本机生成的环境将会失败

请求地址：http://127.0.0.1:8181/api?reqCode=7004

请求参数

参数	是否必选	说明
reqCode	是	编号：7004，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"一键还原成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有任务在运行",
	"Data":null
}

一键还原下个环境-7005

功能说明：请求插件还原下一个环境。非本机生成的环境将会失败

请求地址：http://127.0.0.1:8181/api?reqCode=7005

请求参数

参数	是否必选	说明
reqCode	是	编号：7005，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"一键还原成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有任务在运行",
	"Data":null
}

任务状态查询-7011

功能说明：任务状态查询 -- 与一键清理和一键还原配套使用，当任务生成，一直循环查询任务完成情况

请求地址：http://127.0.0.1:8181/api?reqCode=7011&taskId=888

请求参数

参数	是否必选	说明
reqCode	是	编号：7011，接口请求码
taskId	是	任务Id

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： EnvIdr：环境配置Id/int类型 ConfigDir：环境配置所在目录/String类型 WarningMsg：任务警告信息/String数组类型

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "任务成功" 
    "Data": {       
            "EnvId": 1,    
	        "ConfigDir":"/sdcard/yztc/studiopluing/wipeking/env/xxx",
            "WarningMsg":null 
    }
}

任务成功,存在警告信息
{
    "RespCode": "1", 
    "Message": "任务成功，存在警告信息", 
    "Data": {
            "EnvId": 1, 
            "ConfigDir":"/sdcard/yztc/studiopluing/wipeking/env/xxx",
            "WarningMsg": [
                "xx.apk安装失败", 
                "文件删除失败", 
                "apk卸载失败"
            ]
    }
}

任务执行中
{
    "RespCode": "2", 
    "Message": "任务执行中" 
    "Data": null
} 


接口访问失败
{
    "RespCode": "-1", 
    "Message": "接口访问失败" 
    "Data": null
}

获取当前环境路径-7012

功能说明：获取当前设备使用的清理环境路径。

请求地址：http://127.0.0.1:8181/api?reqCode=7012

请求参数

参数	是否必选	说明
reqCode	是	编号：7012，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： ConfigName：环境名称/String类型 ConfigDir：环境配置所在目录/String类型

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "获取当前路径成功" 
    "Data": {
            "ConfigName":"xxx", 
            "ConfigDir":"/sdcard/yztc/studiopluing/wipeking/env/xxx"
    }
}


接口访问失败
{
    "RespCode": "-1", 
    "Message": "当前环境未初始化" 
    "Data": null
}

当前备份环境记录查询-7013

功能说明：查询当前设备的清理环境历史记录。注意：环境包查询参数在6.8.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7013

请求参数

参数	是否必选	说明
reqCode	是	编号：7013，接口请求码
configName	否	环境包名称/（支持模糊查找）
num	否	获取的数量/默认值为10条

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： ConfigName：环境配置Id/int类型 ConfigDir：环境配置所在目录/String类型

返回值示例说明


任务成功
{
	"Data": [{
		"ConfigName": "AZ016_2019-05-20_11:18:31",
		"EnvId": 72,
		"ConfigDir": "/sdcard/yztc/studioplugin/wipeKing/env/2019-05/20/AZ016_2019-05-20_11:18:31",
		"DateTime": "2019-05-20 11:18:31"
	}, {
		"ConfigName": "AZ016_2019-05-07_15:15:23",
		"EnvId": 71,
		"ConfigDir": "/sdcard/yztc/studioplugin/wipeKing/env/2019-05/7/AZ016_2019-05-07_15:15:23",
		"DateTime": "2019-05-07 15:15:23"
	}],
	"RespCode": "0",
	"Message": "环境信息查询成功"
}


接口访问失败
{
    "RespCode": "-1", 
    "Message": "环境信息查询失败" 
    "Data": null
}

修改环境名称-7014

功能说明：对指定的环境名称进行名称修改。

请求地址：http://127.0.0.1:8181/api?reqCode=7014&configName=xx&updateConfigName=xx

请求参数

参数	是否必选	说明
reqCode	是	编号：7014，接口请求码
configName	是	要修改的原环境名/（非中文）
updateConfigName	是	修改后的环境名/(非中文)

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍：

返回值示例说明


修改成功
{
    "RespCode": "0", 
    "Message": "环境名称修改成功" 
    "Data":null
}

修改失败
{
    "RespCode": "-1", 
    "Message": "环境名称修改失败", 
    "Data": null
}

删除环境-7015

功能说明：删除指定的环境。

请求地址：http://127.0.0.1:8181/api?reqCode=7015&configDirs=/sdcard/yztc/xxxxx/xxx

请求参数

参数	是否必选	说明
reqCode	是	编号：7015，接口请求码
configDirs	是	要删除的环境全路径数组。

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍：

返回值示例说明


删除成功
{
    "RespCode": "0", 
    "Message": "删除成功" 
    "Data":null
}

删除失败
{
    "RespCode": "-1", 
    "Message": "1个环境删除失败--xxxxxx", 
    "Data": null
}

清理无备份的环境包-7016

功能说明：请求插件进行清理本机中没有数据备份的环境包；注意：该接口在6.8.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7016

请求参数

参数	是否必选	说明
reqCode	是	编码：7016，接口请求码
lastSevenDay	否	0：扫描本地所有环境包/（默认）； 1：只扫描近7天的本地环境包

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍： TaskId：任务id/int类型

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"任务请求成功",
	"Data":{"TaskId":8}
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"请求失败，当前已有清理任务在运行",
	"Data":null
}

查看当前环境设备信息-7017

功能说明：请求插件查看当前环境设备信息；注意：该接口在8.0.7后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7017

请求参数

参数	是否必选	说明
reqCode	是	编码：7017，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据，Data返回值详细介绍：当前环境设备信息

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"查看当前环境设备信息成功",
	"Data":{{"运营商":"xx","序列号":"xx","mac":"xx","imei":"xx","主机名":"xx","软件版本":"xx","屏幕Dpi":"xx","源码控制版本号":"xx","显示参数":"xx","厂商":"xx","CPU":"xx","蓝牙mac":"xx","固件版本":"xx","wifi名称":"xx","分辨率":"xx","型号":"xx","ICCID":"xx","硬件":"thhs","主板":"xx","系统版本":"xx","bssid":"xx","android_id":"xx","电话":"xx","sim序列号":"xx","指纹":"xx"}}

}
接口访问失败
{
    "RespCode":"-1",
	"Message":"查看当前环境设备信息失败",
	"Data":null
}

删除当前环境-7018

功能说明：请求插件进行删除当前环境；注意：该接口在8.0.7后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7018

请求参数

参数	是否必选	说明
reqCode	是	编码：7018，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"删除当前环境成功",
	"Data":null
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"删除当前环境失败",
	"Data":null
}

修改当前环境名-7019

功能说明：请求插件进行修改当前环境名；注意：该接口在8.0.7后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7019&configName=新的环境名

请求参数

参数	是否必选	说明
reqCode	是	编码：7019，接口请求码
configName	是	新的环境名

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示

返回值示例说明


任务成功
{
    "RespCode":"0",
	"Message":"修改当前环境名成功",
	"Data":null
}
接口访问失败
{
    "RespCode":"-1",
	"Message":"修改当前环境名失败",
	"Data":null
}

环境备份名设置-7021

功能说明：对一键清理时的环境备份名进行自定义设置

请求地址：http://127.0.0.1:8181/api?reqCode=7021&configName=czgg_@dateTime_@eqpCode

请求参数

参数	是否必选	说明
reqCode	是	编号：7021，接口请求码
configName	否	新的环境备份名（仅支持英文），当该值为空时，系统会采用默认策略来代替，设备编码+时间；在自定义中，可用以下转义符参与命名：@dateTime为转义时间， @eqpCode为转义设备编码注意：如果名字为一个固定值（无配置转义时间）时，则每次清理时候环境都会被复盖。

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败，请使用英文配置名" 
    "Data": null
}

添加需清理的应用-7022

功能说明：添加需清理的应用 -- 在一键清理前的操作，设定指定某款应用，

请求地址：http://127.0.0.1:8181/api?reqCode=7022&pkgName=com.yztc.studio.plugin&type=add

请求参数

参数	是否必选	说明
reqCode	是	编号：7022，接口请求码
pkgName	是	包名/string
type	否	类型值(add/replace)，默认值为覆盖 add：添加，新增指定的包名，原已选择的包名不删除 replace：覆盖，新增指定的包名，删除原已选择的所有包名

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

设置自定义IMEI-7024

功能说明：设置自定义IMEI,注意：该接口在8.0.7后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7024&mode=1&imei=1235467891012345,1235467891012340&addType=append

请求参数

参数	是否必选	说明
reqCode	是	编号：7024，接口请求码
mode	是	imei生成模式/int 0：跟随系统随机 1：用户自定义
imei	否	取值：15位数的imei，中间使用"，"进行分割
addType	否	添加自定义imei的方式/string 取值：append/replace/默认append append：追加 replace：替换

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

添加自动卸载的应用-7025

功能说明：添加自动卸载的应用,注意：该接口在9.5.7后支持

请求地址：http://127.0.0.1:8181/api?"reqCode=7025&pkgName=应用包名&type=添加方式

请求参数

参数	是否必选	说明
reqCode	是	编号：7025，接口请求码
pkgName	是	应用包名
type	否	添加自动卸载的应用的方式/string add/replace/默认cleanAll add：添加 replace：替换 cleanAll：清空

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "添加成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "添加失败" 
    "Data": null
}

运行沙盒内应用-7031

功能说明：运行沙盒内应用,注意：该接口在8.5.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7031&pkgName=com.yztc.studio.plugin

请求参数

参数	是否必选	说明
reqCode	是	编号：7031，接口请求码
pkgName	否	应用包名/string

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

退出模拟器安全模式-7032

功能说明：退出模拟器安全模式,注意：该接口在8.5.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=7032

请求参数

参数	是否必选	说明
reqCode	是	编号：7032，接口请求码

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

压缩文件-5005

功能说明：压缩文件

请求地址：http://127.0.0.1:8181/api?reqCode=5005&filePath=/sdcard/test&zipPath=/sdcard/yztc/test.zip

请求参数

参数	是否必选	说明
reqCode	是	编号：5005，接口请求码
filePath	是	要压缩的文件路径/string 支持目录或文件
zipPath	是	压缩后的zip文件路径/string

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

解压文件-5006

功能说明：解压文件

请求地址：http://127.0.0.1:8181/api?reqCode=5006&zipPath=/sdcard/yztc/test.zip&unZipPath=/sdcard/yztc

请求参数

参数	是否必选	说明
reqCode	是	编号：5005，接口请求码
zipPath	是	需要压缩的zip文件路径/string
filePath	是	解压后的文件存放路径/string

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

上传ftp文件-5007

功能说明：上传ftp文件,注意：该接口在8.5.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=5007&ftpIp=127.0.0.1&ftpPort=21&account=ftpuser&password=123456&ftpPath=/yztc/ldsdk&localPath=/sdcard/ldsdk

请求参数

参数	是否必选	说明
reqCode	是	编号：5007，接口请求码
ftpIp	是	FTP地址/string
ftpPort	是	FTP端口,正常设置21/int
account	是	FTP账号/string
password	是	FTP密码/string
localPath	是	本机文件路径/string
ftpPath	是	FTP存放路径/string

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

下载ftp文件-5008

功能说明：下载ftp文件,注意：该接口在8.5.8后支持

请求地址：http://127.0.0.1:8181/api?reqCode=5008&ftpIp=127.0.0.1&ftpPort=21&account=ftpuser&password=123456&ftpPath=/yztc/ldsdk&localPath=/sdcard/ldsdk

请求参数

参数	是否必选	说明
reqCode	是	编号：5008，接口请求码
ftpIp	是	FTP地址/string
ftpPort	是	FTP端口,正常设置21/int
account	是	FTP账号/string
password	是	FTP密码/string
ftpPath	是	FTP存放路径/string
localPath	是	本机文件路径/string

响应参数

参数	说明
RespCode	0：表示成功，1：表示成功但存在警告信息，-1：表示失败，2：表示任务执行中
Message	消息提示
Data	数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "设置成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "设置失败" 
    "Data": null
}

帮助中心

抹机王API调用 接口文档

一键清理-7001

请求参数

响应参数

返回值示例说明

一键还原-7002

请求参数

响应参数

返回值示例说明

一键备份环境数据-7003

请求参数

响应参数

返回值示例说明

一键还原上个环境-7004

请求参数

响应参数

返回值示例说明

一键还原下个环境-7005

请求参数

响应参数

返回值示例说明

任务状态查询-7011

请求参数

响应参数

返回值示例说明

获取当前环境路径-7012

请求参数

响应参数

返回值示例说明

当前备份环境记录查询-7013

请求参数

响应参数

返回值示例说明

修改环境名称-7014

请求参数

响应参数

返回值示例说明

删除环境-7015

请求参数

响应参数

返回值示例说明

清理无备份的环境包-7016

请求参数

响应参数

返回值示例说明

查看当前环境设备信息-7017

请求参数

响应参数

返回值示例说明

删除当前环境-7018

请求参数

响应参数

返回值示例说明

修改当前环境名-7019

请求参数

响应参数

返回值示例说明

环境备份名设置-7021

请求参数

响应参数

返回值示例说明

添加需清理的应用-7022

请求参数

响应参数

返回值示例说明

设置自定义IMEI-7024

请求参数

响应参数

返回值示例说明

添加自动卸载的应用-7025

请求参数

响应参数

返回值示例说明

运行沙盒内应用-7031

请求参数

响应参数

返回值示例说明

退出模拟器安全模式-7032

请求参数

抹机王API调用接口文档