FreshlianceFreshliance
Tracker文档
网关文档
  • English
  • 简体中文
Tracker文档
网关文档
  • English
  • 简体中文
  • API介绍

    • 概述
    • 参数
    • 签名
    • 规则
    • 错误码
  • API列表

    • 用户信息
    • 获取设备信息
    • 设备数据
    • 设备分组树
    • 分组内设备
    • 修改设备参数
    • 传感器模板

改变设备参数

接口说明

修改设备本身的参数数据

接口方法

gw.deviceCmd.updateParameter

请求参数

名称类型必选描述示例值
recordIdint是记录ID2346
buzzerStatusint是蜂鸣器开关
1:开启
2:关闭
1
temperatureUnitstring是温度单位
1:摄氏度
2:华氏度
1

返回数据

名称类型必选描述示例值
databool是true成功,false失败true

请求示例

{   
	"appId": "658409073956360262328652394",
	"method": "gw.device.updateParameter",
	"format": "JSON",
	"charset": "UTF-8",
	"signType": "RSA2",
	"timestamp": "1755662900000",
	"version": "1.0",
	"bizContent":{
		"recordId":12847,
		"buzzerStatus":1,
		"temperatureUnit":1
	},   
"sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw==" 
}

返回示例

{
    "code": "0",
    "data": true,
    "msg": "success",
    "sign": "eAnF+imkUl+PQSOKAT4d01WSpCg+qH2a/ai/QqDbzoGiMMAAduoXGj36aTbs0iM7WEvoCrqwrPSP7G2ASOEZVCWlCna0WK3OX15wj8JMJ1cd5USoyBo44IW0mTLHs5bTjy73yEqF/g50F1ZeJvBw+aESSji5S48oGvrH1wXaSfCTZQ5+ReL9ZHvzU2lWVSfpS9DCuQ7f6g3uYBNWKAVVeRSki95Awsv4Yiqi8SBOa2ERbXmwp6LGllBEpJNarBf5VAvHUGeDSWD2nQWPsyWceZaAfViQCYf7jdMZ8JmI6bQHrYuCnhHLAjaI84DozDGc3CadZHdgOjwsO57nz9WPeQ==",
    "subCode": "",
    "subMsg": ""
}

保存历史数据关机

接口说明

将设备内未上传到服务器的数据上传完成之后关机

接口方法

gw.deviceCmd.saveDataShutdown

请求参数

名称类型必选描述示例值
recordIdint是记录id2543

返回数据

名称类型必选描述示例值
databool是true成功 false失败true

请求示例

{   
	"appId": "658409073956360262328652394",
	"method": "gw.deviceCmd.saveDataShutdown",
	"format": "JSON",
	"charset": "UTF-8",
	"signType": "RSA2",
	"timestamp": "1755662900000",
	"version": "1.0",
	"bizContent":{
		"recordId":12847
	},  
"sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw==" 
}

返回示例

{
    "code": "0",
    "data": true,
    "msg": "success",
    "sign": "eAnF+imkUl+PQSOKAT4d01WSpCg+qH2a/ai/QqDbzoGiMMAAduoXGj36aTbs0iM7WEvoCrqwrPSP7G2ASOEZVCWlCna0WK3OX15wj8JMJ1cd5USoyBo44IW0mTLHs5bTjy73yEqF/g50F1ZeJvBw+aESSji5S48oGvrH1wXaSfCTZQ5+ReL9ZHvzU2lWVSfpS9DCuQ7f6g3uYBNWKAVVeRSki95Awsv4Yiqi8SBOa2ERbXmwp6LGllBEpJNarBf5VAvHUGeDSWD2nQWPsyWceZaAfViQCYf7jdMZ8JmI6bQHrYuCnhHLAjaI84DozDGc3CadZHdgOjwsO57nz9WPeQ==",
    "subCode": "",
    "subMsg": ""
}

立即关机

接口说明

即使设备还有未发送完的数据,舍弃服务器未接收到的数据直接关机

接口方法

gw.deviceCmd.directShutdown

请求参数

名称类型必选描述示例值
recordIdint是记录id2361

返回数据

名称类型必选描述示例值
databool是true成功 ,false失败true

请求示例

{   
	"appId": "658409073956360262328652394",
	"method": "gw.deviceCmd.directShutdown",
	"format": "JSON",
	"charset": "UTF-8",
	"signType": "RSA2",
	"timestamp": "1755662900000",
	"version": "1.0",
	"bizContent":{
		"recordId":12847
	},  
"sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw==" 
}

返回示例

{
    "code": "0",
    "data": true,
    "msg": "success",
    "sign": "n+jxGTJvT/+vbv8N4o2hyBi+7B1Hyg9tFAUoo6fMLPdmrbwyG9LRWpz9JWXaLG2rbapNe2US7Fqy20o4lfyMqYVw4FQ9+bunr/BfaWF7QNynoJ3z36dNicQ78NEZXNTEN+R4u36vE1TKpUkc7/zir+DyWcyz33FGXWVFKNRapKy7rpcfTt64MgPRfScexbeNRJje7kZVeiaawJ0R1fLhPjjZ9K+u7BIDH+WPHf3Q1q+DuZGxgsUApX5Vxgm/qpMeK5NNc/15X2RHlssYv3FQWrZK/EttCnLlclqmS03+857QE5CxAy0lqJkD2PKphxEMnkHSyeDqA8u0JysxsTH81A==",
    "subCode": "",
    "subMsg": ""
}

保存历史数据重新配置

接口说明

设备数据发送完毕后重新配置设备

接口方法

gw.deviceCmd.saveDataConfig

请求参数

名称类型必选描述示例值
issuedDeviceCmdobject是下发设备指令
issuedDeviceCmd.recordIdlong是设备记录id2356
sensorAlarmListarray[object]否传感器报警点列表
sensorAlarmList.alarmZonestring否报警区域
高:H
低:L
H
sensorAlarmList.alarmPropertyint否报警属性
1:温度
2:湿度
3:光照
4:CO2
2
sensorAlarmList.alarmTypeint否报警类别
1:低报
2:高报
1
sensorAlarmList.probeTypeint否探头类型
0:内置
1:外置1
2:外置2
0
sensorAlarmList.alarmWayint否报警方式
1:单次
2:累计
1
sensorAlarmList.alarmDelayint否报警延时10
sensorAlarmList.alarmThresholddouble否阈值50.0
wifiConfigInfoobject是设备基本信息
wifiConfigInfo.userDeviceIdint是用户设备Id2356
wifiConfigInfo.notifyEmailFlagint否邮件通知
1通知
2不通知
1
wifiConfigInfo.notifyDayEmailCountint否每日邮箱通知条数10
wifiConfigInfo.notifyEmailIntervalint否邮箱通知间隔10
wifiConfigInfo.notifySingleEmailCountint否单个设备邮箱通知次数10
wifiConfigInfo.notifyAlarmEmailstring否报警邮件(多个用,分隔)freshliance@xjwl.com
wifiConfigInfo.notifySmsFlagint否短信通知
1通知
2不通知
1
wifiConfigInfo.notifyDaySmsCountint否每日短信通知条数10
wifiConfigInfo.notifySmsIntervalint否短信通知间隔10
wifiConfigInfo.notifySingleSmsCountint否单个报警点短信通知次数10
wifiConfigInfo.notifyAlarmSmsstring否报警短信(多个用,分隔)+86-139******11
wifiConfigInfo.notifyVoiceFlagint否语音通知
1通知
2不通知
1
wifiConfigInfo.notifyDayVoiceCountint否每日语音通知条数1
wifiConfigInfo.notifyVoiceIntervalint否语音通知间隔1
wifiConfigInfo.notifySingleVoiceCountint否单个报警点语音通知次数1
wifiConfigInfo.notifyAlarmVoicestring否报警语音(多个用,分隔)+86-139******11
wifiConfigInfo.notifyTimeFlagint否时间通知标识
0:默认未设置
1:邮箱使用时间
2:短信使用默认时间
3:邮箱短信使用默认时间
0
wifiConfigInfo.notifyStartTimestring否通知开始时间00:00
wifiConfigInfo.notifyEndTimestring否通知结束时间23:59
wifiConfigInfo.notifyDatestring否通知日期0,1,2 0:表示周日
issuedDeviceCmdConfigobject是下发的配置信息
issuedDeviceCmdConfig.temperatureUnitint是温度单位
1:摄氏度℃
2:华氏度℉
1
issuedDeviceCmdConfig.timeZonestring是UTC时区+08:00
issuedDeviceCmdConfig.buzzerStatusint是蜂鸣器开关
1:开启
2:关闭
1
startDelayint否启动延时1
collectIntervalint是采样周期1
uploadIntervalint是上传间隔1
probeInfoListobject是探头信息
probeInfoList.probeTypeint是探头类型
0:内置
1:外置1
2:外置2
0
probeInfoList.probePropertyint是探头属性
0:未生效
1:单温
2:温湿
3:单湿
0

返回数据

名称类型必选描述示例值
databool是true配置成功 false配置失败true

请求示例

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceCmd.saveDataConfig",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1755662900000",
  "version": "1.0",
  "bizContent": {
    "issuedDeviceCmd": {
    "recordId": "83986"
  },
  "sensorAlarmList": [
    {
      "alarmProperty": 1,
      "alarmType": 2,
      "probeType": 0,
      "alarmWay": 1,
      "alarmDelay": 0,
      "alarmThreshold": -10,
      "alarmZone": "H"
    }
  ],
  "wifiConfigInfo": {
    "notifyEmailFlag": 1,
    "notifyDayEmailCount": 20,
    "notifySingleEmailCount": 1,
    "notifyEmailInterval": 30,
    "notifySmsFlag": 1,
    "notifyDaySmsCount": 20,
    "notifySmsInterval": 30,
    "notifySingleSmsCount": 1,
    "notifyVoiceFlag": 1,
    "notifyDayVoiceCount": 20,
    "notifyVoiceInterval": 0,
    "notifySingleVoiceCount": 1,
    "notifyAlarmVoice": "+86-1733531153,",
    "notifyAlarmEmail": "1813094047@qq.com",
    "notifyAlarmSms": "+86-1733531153,",
    "userDeviceId": "5996",
    "notifyTimeFlag": 3,
    "notifyStartTime": "00:00",
    "notifyEndTime": "23:59",
    "notifyDate": "0,1,2,3,4,5,6"
  },
  "issuedDeviceCmdConfig": {
    "timeZone": "+00:00",
    "temperatureUnit": 1,
    "buzzerStatus": 1
  },
  "collectInterval": 1,
  "uploadInterval": 1,
  "probeInfoList": [
    {
      "probeType": 0,
      "probeProperty": 2
    },
    {
      "probeType": 1,
      "probeProperty": 2
    },
    {
      "probeType": 2,
      "probeProperty": 2
    }
  ]
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

返回示例

{
    "code": "0",
    "data": 1519,
    "msg": "success",
    "sign": "LBg1K82gXXnkTaP0PKFWhXv/DIhnR2WnWu5HKT9FA3s9XQEQyMq2LbXsIG9GIXDRqYPLLiKmbLYYzDDnLV1k3MCFTpSsskvvYQZqqisyiq+Fz8eCKXgBQgZoOE1qhuy7PSebAuiUktuHacBaAQJph+eUlXAsFnri+xH7C8C6VuGCVLMVRwViBk1UO5+AVBifmOzugbgEyIPLGRwVhiqi2sSoengceeg7bVmr9BJ2cg9ceh5dsNVGuTc7jEg4gR1AWxYNuUJVw1/q02ABNH8w3Jkyd9XUofiKpTwTgErL8bQGKNx2VuGoR9ORZ27Md2o2kNbiYATulLWx+1fDS0OuUg==",
    "subCode": "",
    "subMsg": ""
}

立即重新配置

接口说明

设备立即进行重新配置

接口方法

gw.deviceCmd.directConfig

请求参数

名称类型必选描述示例值
issuedDeviceCmdobject是下发设备指令
issuedDeviceCmd.recordIdlong是设备记录id2356
sensorAlarmListarray[object]否传感器报警点列表
sensorAlarmList.alarmZonestring否报警区域
高:H 低:L
H
sensorAlarmList.alarmPropertyint否报警属性
1:温度
2:湿度3:光照
4:CO2
2
sensorAlarmList.alarmTypeint否报警类别
1:低报
2:高报
1
sensorAlarmList.probeTypeint否探头类型
0:内置
1:外置1
2:外置2
0
sensorAlarmList.alarmWayint否报警方式
1:单次
2:累计
1
sensorAlarmList.alarmDelayint否报警延时10
sensorAlarmList.alarmThresholddouble否阈值50.0
wifiConfigInfoobject是设备基本信息
wifiConfigInfo.userDeviceIdint是用户设备Id2356
wifiConfigInfo.notifyEmailFlagint否邮件通知
1:通知
2:不通知
1
wifiConfigInfo.notifyDayEmailCountint否每日邮箱通知条数10
wifiConfigInfo.notifyEmailIntervalint否邮箱通知间隔10
wifiConfigInfo.notifySingleEmailCountint否单个设备邮箱通知次数10
wifiConfigInfo.notifyAlarmEmailstring否报警邮件(多个用,分隔)freshliance@xjwl.com
wifiConfigInfo.notifySmsFlagint否短信通知
1:通知
2:不通知
1
wifiConfigInfo.notifyDaySmsCountint否每日短信通知条数10
wifiConfigInfo.notifySmsIntervalint否短信通知间隔10
wifiConfigInfo.notifySingleSmsCountint否单个报警点短信通知次数10
wifiConfigInfo.notifyAlarmSmsstring否报警短信(多个用,分隔)+86-139******11
wifiConfigInfo.notifyVoiceFlagint否语音通知
1:通知
2:不通知
1
wifiConfigInfo.notifyDayVoiceCountint否每日语音通知条数1
wifiConfigInfo.notifyVoiceIntervalint否语音通知间隔1
wifiConfigInfo.notifySingleVoiceCountint否单个报警点语音通知次数1
wifiConfigInfo.notifyAlarmVoicestring否报警语音(多个用,分隔)+86-139******11
wifiConfigInfo.notifyTimeFlagint否时间通知标识
0:默认未设置
1:邮箱使用时间
2:短信使用默认时间
3:邮箱短信使用默认时间
0
wifiConfigInfo.notifyStartTimestring否通知开始时间00:00
wifiConfigInfo.notifyEndTimestring否通知结束时间23:59
wifiConfigInfo.notifyDatestring否通知日期0,1,2 0:表示周日
issuedDeviceCmdConfigobject是下发的配置信息
issuedDeviceCmdConfig.temperatureUnitint是温度单位
1:摄氏度℃
2:华氏度℉
1
issuedDeviceCmdConfig.timeZonestring是UTC时区+08:00
issuedDeviceCmdConfig.buzzerStatusint是蜂鸣器开关
1:开启
2:关闭
1
startDelayint是启动延时1
collectIntervalint是采样周期1
uploadIntervalint是上传间隔1
probeInfoListobject是探头信息
probeInfoList.probeTypeint是探头类型
0:内置
1:外置1
2:外置2
0
probeInfoList.probePropertyint是探头属性
0未生效
1单温
2:温湿
3:光照
4:CO2
0
collectIntervalint是采样周期
uploadIntervalint是上传间隔
probeInfoListobject是探头信息
probeInfoList.probeTypeint是探头类型
0:内置
1:外置1
2:外置2
probeInfoList.probePropertyint是探头属性
0:未生效
1:单温
2:温湿
3:单湿

返回数据

名称类型必选描述示例值
databool是true配置成功 false配置失败true

请求示例

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceCmd.directConfig",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1755662900000",
  "version": "1.0",
  "bizContent": {
    "issuedDeviceCmd": {
    "recordId": "83986"
  },
  "sensorAlarmList": [
    {
      "alarmProperty": 1,
      "alarmType": 2,
      "probeType": 0,
      "alarmWay": 1,
      "alarmDelay": 0,
      "alarmThreshold": -10,
      "alarmZone": "H"
    }
  ],
  "wifiConfigInfo": {
    "notifyEmailFlag": 1,
    "notifyDayEmailCount": 20,
    "notifySingleEmailCount": 1,
    "notifyEmailInterval": 30,
    "notifySmsFlag": 1,
    "notifyDaySmsCount": 20,
    "notifySmsInterval": 30,
    "notifySingleSmsCount": 1,
    "notifyVoiceFlag": 1,
    "notifyDayVoiceCount": 20,
    "notifyVoiceInterval": 0,
    "notifySingleVoiceCount": 1,
    "notifyAlarmVoice": "+86-1733531153,",
    "notifyAlarmEmail": "1813094047@qq.com",
    "notifyAlarmSms": "+86-1733531153,",
    "userDeviceId": "5996",
    "notifyTimeFlag": 3,
    "notifyStartTime": "00:00",
    "notifyEndTime": "23:59",
    "notifyDate": "0,1,2,3,4,5,6"
  },
  "issuedDeviceCmdConfig": {
    "collectInterval": 1,
    "uploadInterval": 1,
    "timeZone": "+00:00",
    "temperatureUnit": 1,
    "buzzerStatus": 1
  },
  "collectInterval": 1,
  "uploadInterval": 1,
  "probeInfoList": [
    {
      "probeType": 0,
      "probeProperty": 2
    },
    {
      "probeType": 1,
      "probeProperty": 2
    },
    {
      "probeType": 2,
      "probeProperty": 2
    }
  ]
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

返回示例

{
    "code": "0",
    "data": 1520,
    "msg": "success",
    "sign": "C+BfOvfpbKtstLSryTLNp3ib/txmOrClp9/jHRtwypn9D+CeAlN+57eXyn8u5Ukv1b8UQ7jm/HcWW2Euyx79cQ+DGnXrUTcjywHiyWnmrNVKNmDEPin2wcV96wXojCef7cvbmqxZjV98T9cQiM+6LtrkqalHcMDqIceq6HegCXRG9s4YINPurBam4BQvtMNRUs3+rdqlQ7qMkdcHKxJdoS1A4k7639GHCsurTeB2shuUIAmjLpeOncgGXZU7n7RVsowQZqx2LO2hCoaRm2Q0hxD3TB2Nye0o7p0e7TMcY7Qj/5Jd4byc8X9LSUGPPlBunequxpH63AeGcFrd18F/8A==",
    "subCode": "",
    "subMsg": ""
}

删除远程下发命令

接口说明

在设备没有获取下发命令的情况下进行设备下发命令的删除,使其下发命令失效

接口方法

gw.deviceCmd.delete `

请求参数

名称类型必选描述示例值
idint是远程命令ID726

返回数据

名称类型必选描述示例值
databool是true成功,false失败true

请求示例

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceCmd.delete",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1755662900000",
  "version": "1.0",
  "bizContent": {
    "id": 1521
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

返回示例

{
  "code": "0",
  "data": true,
  "msg": "success",
  "sign": "eAnF+imkUl+PQSOKAT4d01WSpCg+qH2a/ai/QqDbzoGiMMAAduoXGj36aTbs0iM7WEvoCrqwrPSP7G2ASOEZVCWlCna0WK3OX15wj8JMJ1cd5USoyBo44IW0mTLHs5bTjy73yEqF/g50F1ZeJvBw+aESSji5S48oGvrH1wXaSfCTZQ5+ReL9ZHvzU2lWVSfpS9DCuQ7f6g3uYBNWKAVVeRSki95Awsv4Yiqi8SBOa2ERbXmwp6LGllBEpJNarBf5VAvHUGeDSWD2nQWPsyWceZaAfViQCYf7jdMZ8JmI6bQHrYuCnhHLAjaI84DozDGc3CadZHdgOjwsO57nz9WPeQ==",
  "subCode": "",
  "subMsg": ""
}
Prev
分组内设备
Next
传感器模板