冰狐智能辅助
首页
文档&下载
移动端
微服务
社区
码农教程
管理中心
关于我们
登录/注册
服务端api

服务端脚本API

服务端脚本可以直接调用这些api来完成业务逻辑。getUser、userList、deviceList、setUserSupportScripts、getDeviceInfo、deviceStart、deviceReset、setDeviceExtraData、scriptList、scriptExe、dbInsert、dbQuery、dbUpdate、dbDelete、httpPost、httpGet、cachePut、cacheGet、cacheRemove、lock、unlock、releaseLock、createPassport、getPassport、base64Encode、base64Decode、encodeURI、decodeURI、getCustomData、setCustomData

getUser

根据user的openId，返回用户信息。
参数：
参数名 类型 必填 说明
openId string 选填 用户的id，默认为空，表示返回当前用户信息
返回用户json object：
名称 类型 说明
openId string 用户id
username string 用户名
phoneNumber string 电话号码
email string 电子邮箱
wx string 微信号
createTime integer 创建时间

userList

返回当前管理员下的用户，类型为json array，每个user为一个json object，详见getUser部分。
参数：
参数名 类型 必填 说明
startIndex integer 选填 起始位置，默认为0
itemCount integer 选填 一页最大数据项，默认为-1，表示返回startIndex起始位置后的所有数据项

setUserSupportScripts

设置子账户的支持的脚本，返回boolean。
参数：
参数名 类型 必填 说明
openId string 必填 子账户的openId
scripts string 必填 脚本名，多个脚本用#分割，比如:淘宝#抖音#快手

deviceList

返回指定用户下的设备，类型json array，每个device为一个json object。
参数：
参数名 类型 必填 说明
openId string 选填 用户的openId，默认为''，表示获取当前管理员的设备
startIndex integer 选填 起始位置，默认为0
itemCount integer 选填 一页最大数据项，默认为-1，表示返回startIndex起始位置后的所有数据项
返回设备json object：
名称 类型 说明
uuid string 设备uuid
name string 设备名
phoneNumber string 设备手机号
extraData json object string 用于存放开发者自定义数据
enable boolean 设备是否可用，false表示设备目前不可用
days integer 可用天数
onlineState integer 工作状态，0表示离线，1表示在线，2表示在线但服务不可用
workState integer 工作状态，0表示空闲，1表示繁忙
devState integer 开发模式，0表示开发模式，1表示发布模式

getDeviceInfo

获取设备信息，具体返回值见deviceList。
参数：
参数名 类型 必填 说明
uuid string 必填 设备uuid

getDeviceState

获取设备状态。
参数：
参数名 类型 必填 说明
uuid string 必填 设备uuid
返回json object：
名称 类型 说明
onlineState integer 工作状态，0表示离线，1表示在线，2表示在线但服务不可用
workState integer 工作状态，0表示空闲，1表示繁忙

deviceStart

启动设备，若scriptName不为空则执行，否则查看设备默认脚本，有则执行该脚本；否则查看用户默认脚本，有则执行该脚本。 返回boolean。
参数：
参数名 类型 必填 说明
uuid string 必填 设备uuid
scriptName string 选填 脚本名，默认为空，脚本名为空时执行设备的默认脚本

deviceReset

复位设备(停止设备)，返回boolean。
参数：
参数名 类型 必填 说明
uuid string 必填 设备uuid
refreshApp boolean 选填 停止脚本后是否把冰狐切换到前台，默认：true

setDeviceExtraData

设置设备自定义数据，返回boolean。
参数：
参数名 类型 必填 说明
uuid string 必填 设备uuid
data string 必填 数据

scriptList

返回移动端脚本，类型json array，每个script为一个json object。
参数：
参数名 类型 必填 说明
openId string 选填 用户的openId，默认为''，表示获取当前管理员的脚本
startIndex integer 选填 起始位置，默认为0
itemCount integer 选填 一页最大数据项，默认为-1，表示返回startIndex起始位置后的所有数据项
返回设备json object：
名称 类型 说明
name string 脚本名
data string 脚本调试数据
version integer 脚本调试版本
releaseData string 脚本发布数据
releaseVersion integer 脚本部署版本
state int 状态，1表示public，0表示private
modifyTime timestamp 修改时间
createTime timestamp 创建时间

scriptExe

执行脚本，返回boolean数组（支持多个设备，仅在同步模式下返回值才有意义）。
参数：
参数名 类型 必填 说明
scriptName string 必填 脚本名
device uuid string/json array 必填 设备，当类型为string时表示设备uuid，当类型为json array时表示设备uuid数组
params json array 选填 脚本参数
forceRun boolean 选填 当目标设备繁忙时是否强制执行当前脚本，默认：false
exeDefaultTaskWhenFinished boolean 选填 当前脚本结束时是否执行默认脚本，默认：false
sync boolean 选填 是否使用同步方式，默认：false。仅在同步模式下返回值才有意义
refreshApp boolean 选填 在执行脚本前是否把冰狐切换到前台，默认：false

dbInsert

向数据库插入数据项。成功返回插入数据项的id，失败返回-1。
参数：
参数名 类型 必填 说明
tableName string 必填 表名
data json object 必填 插入数据项，例：{price:1, type: 2, deviceId:'xxxx'}

dbQuery

查询数据库。返回json数组，数组元素为json对象。
参数：
参数名 类型 必填 说明
tableNames string 必填 表名，用','分割多个表名
columns string 必填 返回数据的列名，，用','分割多个列名
conditions json array 必填 查询条件，字符串数组，每个字符串一个条件，例：["type=1", "len>3"]
order string 选填 默认为空，例：order by name desc
offset integer 选填 默认为0
limit integer 选填 默认-1，表示offset之后的所有数据

dbUpdate

更新数据。返回Boolean。
参数：
参数名 类型 必填 说明
tableName string 必填 表名
sets json array 必填 更新值，字符串数组，每个字符串一个赋值列，例：["name='tom'", "value=1"]
conditions json array 必填 更新条件，字符串数组，每个字符串一个条件，例：["type=1", "len>3"]

dbDelete

删除数据。返回Boolean。
参数：
参数名 类型 必填 说明
tableName string 必填 表名
conditions json array 必填 删除条件，字符串数组，每个字符串一个条件，例：["type=1", "len>3"]

httpPost

post。返回json对象, {status: ..., data: ...}。
参数：
参数名 类型 必填 说明
url string 必填 url
bodyParams json object 选填 默认为空
contentType string 选填 application/json;charset=UTF-8
queryParams json object 选填 默认为空

httpGet

get。返回json对象, {status: ..., data: ...}。
参数：
参数名 类型 必填 说明
url string 必填 url
queryParams json object 选填 默认为空

cachePut

往cache存放数据，返回Boolean。
参数：
参数名 类型 必填 说明
key string 必填 key
value object 必填 value
timeout integer 选填 过期时间，毫秒，默认值：120000

cacheGet

从cache取数据，返回Object。
参数：
参数名 类型 必填 说明
key string 必填 key

cacheRemove

从缓存中移除数据，返回boolean。
参数：
参数名 类型 必填 说明
key string 必填 key

lock

加锁，若锁不存在则先创建锁再加锁，用于多线程同步，返回boolean。
参数：
参数名 类型 必填 说明
name string 必填 锁名字

unlock

解锁，用于多线程同步，返回boolean。
参数：
参数名 类型 必填 说明
name string 必填 锁名字

releaseLock

若锁存在则销毁，用于多线程同步，返回boolean。
参数：
参数名 类型 必填 说明
name string 必填 锁名字

createPassport

创建卡密，返回boolean。
参数：
参数名 类型 必填 说明
hours integer 必填 卡密时间（分钟）
count integer 选填 创建count个卡密，默认为1
supportScripts String 选填 支持的脚本，多个脚本以#分割，比如：抖音#快手。注意：如果不为空，则该卡密仅支持指定的脚本，否则支持所有脚本

getPassport

获取卡密，返回json对象, {list: passwords, total:count}。
参数：
参数名 类型 必填 说明
childOpenId string 选填 子用户的openId，默认为空则返回所有卡密
uuid string 选填 某个设备的设备id，默认为空则返回所有卡密
cursor integer 选填 分页游标，默认为0
count integer 选填 页大小，默认为-1，返回所有

transferPassport

转移卡密，返回boolean。将卡密转移给对应的子用户，转移后子用户在登录冰狐后看到对应的卡密。
参数：
参数名 类型 必填 说明
passport String 必填 卡密
openId String 必填 子账户的openId

base64Encode

base64编码，返回string。
参数：
参数名 类型 必填 说明
data byte[] 必填 待编码的字节数组

base64Decode

base64解码，返回byte[]。
参数：
参数名 类型 必填 说明
data string 必填 待解码的字符串

encodeURI

encode uri，返回string。
参数：
参数名 类型 必填 说明
data string 必填 待编码的字符串

decodeURI

decode uri，返回string。
参数：
参数名 类型 必填 说明
data string 必填 待解码的字符串

getCustomData

获取用户在「管理中心」/「自定义数据」中创建的数据项，返回结果结果为string。
参数：
参数名 类型 必填 说明
name string 必填 数据名

setCustomData

设置用户在「管理中心」/「自定义数据」中创建的数据项，返回结果结果为boolean（注意api不会自动创建不存在的自定义数据）。
参数：
参数名 类型 必填 说明
name string 必填 数据名
data string 必填 数据