FreshlianceFreshliance
Tracker document
Gateway document
  • English
  • 简体中文
Tracker document
Gateway document
  • English
  • 简体中文
  • API introduction

    • Overview
    • Parameter
    • Signature
    • Rules
    • Error code
  • API list

    • User information
    • Device information
    • Device data
    • Device group list
    • Grouped device List
    • Remote configuration
    • Sensor template

Obtain Device Category

Interface Description

Obtain current product information category.

Interface Method

gw.device.category

Request Parameter

None

Return Data

NameTypeRequiredDescriptionExample
categoryIdintYesProduct category ID20
categoryNamestringYesProduct category nameTH30/TH20
inTemHighdoubleYesMax. temperature value of built-in sensor100.0
inTemLowdoubleYesMin. temperature value of built-in sensor-30.0
extTemHighdoubleYesMax. temperature value of external probe100.0
extTemLowdoubleYesMin. temperature value of external probe-30.0
productSensorintBuilt-in sensor type
0: Built-in sensor
1: Built-in sensor+ One external probe
2: Built-in sensor+2 external probes
1
remarkstringYesRemarks

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.device.category",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": [
    {
      "productSensor": 0,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "T10",
      "categoryId": 1
    },
    {
      "productSensor": 0,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "TH20",
      "categoryId": 2
    },
    {
      "extTemHigh": 70,
      "extTemLow": -30,
      "productSensor": 2,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "TH10B/TH10R/TH30B/TH30R",
      "categoryId": 3
    },
    {
      "extTemHigh": 500,
      "extTemLow": -200,
      "productSensor": 2,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "TH30R-ETU",
      "categoryId": 4
    },
    {
      "extTemHigh": 200,
      "extTemLow": -80,
      "productSensor": 2,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "TH30R-I/TH10-IRS",
      "categoryId": 5
    },
    {
      "extTemHigh": 200,
      "extTemLow": -200,
      "productSensor": 1,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "LoRa",
      "categoryId": 6
    },
    {
      "extTemHigh": 200,
      "extTemLow": -80,
      "productSensor": 2,
      "inTemHigh": 85,
      "inTemLow": -40,
      "categoryName": "COEUS-WIFI/4G",
      "categoryId": 7
    },
    {
      "extTemHigh": 200,
      "extTemLow": -200,
      "productSensor": 0,
      "inTemHigh": 70,
      "inTemLow": -30,
      "categoryName": "TH30-ERS",
      "categoryId": 8
    },
    {
      "extTemHigh": 190,
      "extTemLow": -90,
      "productSensor": 2,
      "categoryName": "GSP",
      "categoryId": 9
    }
  ],
  "msg": "success",
  "sign": "BavuPcfuDO7T0qD33Bm/oqTqeeoj4vw9eHwPQ9D8AQ5pJTPrzeD/sbMdUYJHYu5px+HuaFuyxk6tiEMkVDLGJd9I/pA66Pv9w16bpEUas15ReUhsoZ4LK10zoR8yc7QN+r/Le4tFnFpP8FTIgYlclUVoWHvbVRPNy8qPmiohNr/QTuPhFSWzVYjfpzDw/rtEFUtvCr7gXCEjlBh15gPR/GjYJC9P5/74eVAr7SmFFD+YFPZfpU2DAgADr3EjR4fyujvDxz85wNIFWs/hpfV2uU3snTvTPC1HTL6CwSGkY/k++qSakS8f6UkJUXyg2juz6MjzvfwxtS7oWhJsX+RO1A==",
  "subCode": "",
  "subMsg": ""
}

Obtain Device List Page

Interface Description

Obtain the device information list of the user.

Interface Method

gw.deviceInfo.page

Request Parameter

NameTypeRequiredDescriptionExample
deviceSnstringNoDevice ID201200000W
deviceNamestringNoDevice nameWarehouse 1
deviceStatusintNoDevice status
0: Not activated
1: Online
2: Offline
3: Abnormal
1
alarmStatusintNoAlarm status
1: Alarm
2: Normal
1
productTypeintNoProduct type
1: Gateway
2: Sensor
3: COEUS
4: GSP
1
powerStatusintNoLow battery
0: Normal
1: Low battery <=20
0
keywordstringNoKeyword search
pageNumintYesPage number, starting from 11
pageSizeintYesData quantity each page, Max. 5020

Return Data

NameTypeRequiredDescriptionExample
tatalintYesTotal data quantity22
rowsarray[object]YesData
rows.deviceInfoobjectYesDevice information
rows.deviceInfo.userDeviceIdintYesUser device ID2334
rows.userParentIdintYesParent device ID of the user
rows.deviceInfo.productCodestringYesDevice typeA0
rows.deviceInfo.deviceSnstringYesDevice ID200200210F
rows.deviceInfo.deviceCodestringYesMAC address48E700577E13
rows.deviceInfo.deviceNamestringYesdevice-1仓库1
rows.deviceInfo.deviceIdintYesDevice ID1248
rows.deviceInfo.recordIdintYesRecord ID44651
rows.deviceInfo.productTypeintYesProduct type
1: Gateway
2: Sensor
3: COEUS
4: GSP
3
rows.deviceInfo.productModelstringYesDevice modelCOEUS-WIFI
rows.deviceInfo.userParentIdintYesDevice ID of parent device user123
rows.deviceInfo.deviceStatusintYesDevice status
0: Not activated
1: Online
2: Offline
3: Abnormal
0
rows.deviceInfo.statusTimelongYesStatus time1755662900000
rows.deviceInfo.alarmStatusintYesAlarm status 1: Normal, 2: Alarm2
rows.deviceInfo.alarmTimelongYesAlarm time1755662900000
rows.deviceInfo.devicePowerintYesDevice power22
rows.deviceInfo.powerTimelongYesPower time1755662900000
rows.deviceInfo.gatewaySnstringNoHome gateway ID250700000W
rows.subDeviceLastDataListarraylist[object]YesSub-device data information
rows.subDeviceLastDataList.temperaturedoubleNoTemperature20.0
rows.subDeviceLastDataList.humiditydoubleNoHumidity20.0
rows.subDeviceLastDataList.lightdoubleNoIllumination6000
rows.subDeviceLastDataList.co2doubleNoCO22000
rows.subDeviceLastDataList.dataTimelongYesData time1755662900000
rows.subDeviceLastDataList.temHighdoubleNoMin. value of high temperature alarm20.0
rows.subDeviceLastDataList.temLowdoubleNoMax. value of low temperature alarm10.0
rows.subDeviceLastDataList.humHighdoubleNoMin. value of high humidity alarm20.0
rows.subDeviceLastDataList.humLowdoubleNoMax. value of low humidity alarm10.0
rows.subDeviceLastDataList.lightHighdoubleNoMin. value of high illumination alarm10000
rows.subDeviceLastDataList.lightLowdoubleNoMax. value of low illumination alarm1000
rows.subDeviceLastDataList.co2HighdoubleNoMin. value of high CO2 alarm10000
rows.subDeviceLastDataList.co2LowdoubleNoMax. value of low CO2 alarm1000
rows.subDeviceLastDataList.probeTypeintYesProbe type 0: Built-in 1:External probe 1
2: External probe 2
1
rows.subDeviceLastDataList.probePropertyintYesProbe property 0: Invalid; 1: Temperature; 2: Temperature and humidity; 3:Illumination; 4: CO20
rows.subDeviceLastDataList.probeAlarmStatusintYesProbe alarm status 0: Normal; 1: Temperature alarm; 2: Temperature and humidity alarm; 3: Humidity alarm0
rows.subDeviceLastDataList.probeAlarmTimelongNoProbe alarm time1755662900000
rows.subDeviceLastDataList.statusintYesData status 0: Normal; 1: Probe not connected or not connected properly; 2: Mismatched probe type or malfunction0
rows.deviceDeviceStateCountobjectYesQuantity of the gateway sub-devices in each status
rows.deviceDeviceStateCount.deviceCountintYesTotal quantity of devices1
rows.deviceDeviceStateCount.onlineCountintYesQuantity of online devices0
rows.deviceDeviceStateCount.offlineCountintYesQuantity of offline devices1
rows.deviceDeviceStateCount.alarmCountintYesQuantity of alarm devices0
rows.deviceDeviceStateCount.abnormalCountintYesQuantity of abnormal devices0

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceInfo.page",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 2
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 9,
    "rows": [
      {
        "deviceDeviceStateCount": {
          "alarmCount": 0,
          "onlineCount": 0,
          "offlineCount": 0,
          "deviceCount": 0,
          "abnormalCount": 0
        },
        "deviceInfo": {
          "productModel": "COEUS-WIFI",
          "userDeviceId": 4566,
          "deviceCode": "C4D8D5078C78",
          "deviceSn": "241001383F",
          "deviceId": 2071,
          "deviceName": "241001383F",
          "deviceStatus": 2,
          "recordId": 12922,
          "alarmStatus": 1,
          "powerTime": 1756992726000,
          "productCode": "94",
          "productScene": 2,
          "userParentId": 4566,
          "statusTime": 1757032347000,
          "devicePower": 29,
          "productType": 3,
          "gatewaySn": "241001383F"
        },
        "subDeviceLastDataList": [
          {
            "dataTime": 1756983688000,
            "probeType": 0,
            "probeProperty": 2,
            "temperature": 28,
            "humidity": 57.1,
            "probeAlarmStatus": 0,
            "status": 0
          }
        ]
      },
      {
        "deviceDeviceStateCount": {
          "alarmCount": 0,
          "onlineCount": 0,
          "offlineCount": 0,
          "deviceCount": 0,
          "abnormalCount": 0
        },
        "deviceInfo": {
          "productModel": "COEUS-WIFI",
          "userDeviceId": 4565,
          "deviceCode": "94C960FA2BE6",
          "deviceSn": "200700727F",
          "deviceId": 2085,
          "deviceName": "200700727F",
          "deviceStatus": 2,
          "recordId": 12920,
          "alarmStatus": 1,
          "powerTime": 1756799640000,
          "productCode": "94",
          "productScene": 2,
          "userParentId": 4565,
          "statusTime": 1756800302000,
          "devicePower": 1,
          "productType": 3,
          "gatewaySn": "200700727F"
        },
        "subDeviceLastDataList": [
          {
            "dataTime": 1756799628000,
            "probeType": 0,
            "probeProperty": 2,
            "temperature": 25,
            "humidity": 50.7,
            "probeAlarmStatus": 0,
            "status": 0
          }
        ]
      }
    ]
  },
  "msg": "success",
  "sign": "jiPBJNk0lSwkn4VVqqQsXJVzrgBztf0XOa9DHtO4zTjS6m36w/A636iy00/x57b7SdK6JSvbTqiOa/iiz5sZvvcFY4R6hFDpzS7A6iMQmiD8sSw6HFoaSEDofTbdIeF1Vcc9k7iu1qOY2cDLxfPcj/cdThVyVboYNXAG6TmqahX0gkxuMDKB6C1WSOm78zOSAgcQtbWMfysttpnwUg50Hfpa3h+JHHgyPQlbRnQTqEbeHACMF7Gi31tEwavl5fSxLu0SkkKXzaYeyv0vddUC7XZl+9K8j95y9HCXYkk5YFCFnwUKOI+wPIOkaHe3DIHv1iFULWB27GLpuOYWAlnTUw==",
  "subCode": "",
  "subMsg": ""
}

Obtain Usage Record Page

Interface Description

Obtain the information page of device usage record.

Interface Method

gw.deviceInfo.recordPage

Request Parameter

NameTypeRequiredDescriptionExample
deviceIdintNodeviceId2230
deviceSnstringNoDevice ID201200000W
recordStatusintNoDevice status
1: In use
2: Stopped
1
deviceNamestringNoDevice nameWarehouse 1
startTimelongNoStart time1747640566191
endTimelongNoEnd time1747640566191
productTypeintNoProduct type
1: Gateway
2: Sensor
3: COEUS
4: GSP
1
keywordstringNoKeyword search
pageNumintYesPage number, starting from 11
pageSizeintYesData quantity each page, Max. 5020

Return Data

NameTypeRequiredDescriptionExample
tatalintYesTotal data quantity22
rowsarray[object]YesData
rows.deviceRecordobjectYesDevice record information
rows.deviceRecord.recordIdintYesRecord ID2234
rows.deviceRecord.userDeviceRecordIdintYesUser device record ID22498
rows.deviceRecord.deviceSnstringYesID250100020F
rows.deviceRecord.parentDeviceIdintYesParent device ID22498
rows.deviceRecord.parentDeviceSnstringYesParent device serial number250100020F
rows.deviceRecord.parentDeviceNamestringYesParent device nameWarehouse 1
rows.deviceRecord.deviceNamestringYesdevice-1Container 1
rows.deviceRecord.productModelstringYesDevice modelCOEUS-WIFI
rows.deviceRecord.productTypeintYesDevice type3
rows.deviceRecord.recordStatusintYesRecord status
1: In use
2: Stopped
1
rows.deviceRecord.timeZonestringNoTime zone of the device+08:00
rows.deviceRecord.temperatureUnitintNoTemperature unit
1: ℃
2: ℉
1
rows.deviceRecord.buzzerStatusintNoBuzzer On/Off
1: On
2: Off
1
rows.deviceRecord.collectIntervalintYesLogging interval30
rows.deviceRecord.uploadIntervalintNoUploading interval
rows.deviceRecord.startDelayintNoStart delay
rows.deviceRecord.alarmStatusintYesAlarm status
1: Normal
2: Alarm
11
rows.deviceRecord.alarmTimelongNoAlarm time
rows.deviceRecord.dataCountintYesQuantity of data records20
rows.sensorConfigarray[object]Sensor configuration information
rows.sensorConfig.configIdintYesConfiguration ID2698
rows.sensorConfig.probeTypeintYesProbe type
0: Built-in
1: External probe 1
2: External probe 2
0
rows.sensorConfig.categoryIdintYesCategory ID7
rows.sensorConfig.probePropertyintYesProbe property
0: Invalid
1: Temperature
2: Temperature and humidity
3: Humidity
2
rows.sensorConfig.probeAlarmStatusintYesProbe alarm status
0: Normal
1: Temperature alarm
2: Temperature and humidity alarm
3: Humidity alarm
4:Illumination alarm
5:CO2 alarm
0
rows.sensorConfig.probeAlarmTimelongNoProbe alarm time
rows.sensorConfig.probeAlarmIdintNoProbe alarm ID1322
rows.sensorConfig.parentIdintYesParent configuration ID9700
rows.sensorConfig.productCodestringYesProduct code94
rows.sensorConfig.temHighdoubleNoMin. value of high temperature alarm
rows.sensorConfig.temLowdoubleNoMax. value of low temperature alarm
rows.sensorConfig.humHighdoubleNoMin. value of high humidity alarm
rows.sensorConfig.humLowdoubleNoMax. value of low humidity alarm
rows.sensorConfig.lightHighdoubleNoMin. value of high illumination alarm
rows.sensorConfig.lightLowdoubleNoMax. value of low illumination alarm
rows.sensorConfig.co2HighdoubleNoMin. value of high CO2 alarm
rows.sensorConfig.co2LowdoubleNoMax. value of low CO2 alarm
rows.subDeviceLastDataListarray[object]YesTemperature and humidity information of sub-devices
rows.subDeviceLastDataList.temperaturedoubleNoTemperature20.0
rows.subDeviceLastDataList.humiditydoubleNoHumidity20.0
rows.subDeviceLastDataList.lightdoubleNoIllumination
rows.subDeviceLastDataList.co2doubleNoCO2
rows.subDeviceLastDataList.dataTimelongYesData time1755662900000
rows.subDeviceLastDataList.probeTypeintYesProbe type
0: Built-in
1: External probe 1
2: External probe 2
rows.subDeviceLastDataList.probePropertyintYesProbe property 0: Invalid; 1: Temperature; 2: Temperature and humidity;
3: Illumination
4: CO2
rows.subDeviceLastDataList.probeAlarmStatusintYesProbe alarm status
0: Normal
1: Temperature alarm
2: Temperature and humidity alarm
3: Humidity alarm
rows.subDeviceLastDataList.probeAlarmTimelongNoProbe alarm time
rows.subDeviceLastDataList.statusintYesData status
0: Normal
1: The probe not connected or not connected properly
2: Mismatched probe type or malfunction

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceInfo.page",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 2
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 41,
    "rows": [
      {
        "deviceRecord": {
          "buzzerStatus": 2,
          "productModel": "COEUS-WIFI",
          "userDeviceRecordId": 10523,
          "timeZone": "+08:00",
          "deviceSn": "241090710F",
          "deviceName": "241090710F",
          "dataCount": 125,
          "recordId": 12881,
          "uploadInterval": 1,
          "alarmStatus": 1,
          "recordStatus": 1,
          "collectInterval": 1,
          "temperatureUnit": 1,
          "parentDeviceName": "241090710F",
          "parentDeviceId": 2070,
          "parentDeviceSn": "241090710F",
          "startDelay": 0,
          "productType": 3
        },
        "sensorConfig": [
          {
            "parentId": 47507,
            "productCode": "94",
            "probeType": 1,
            "configId": 47508,
            "probeProperty": 0,
            "probeAlarmStatus": 0
          },
          {
            "parentId": 47507,
            "productCode": "94",
            "probeType": 2,
            "configId": 47509,
            "probeProperty": 0,
            "probeAlarmStatus": 0
          },
          {
            "parentId": 0,
            "productCode": "94",
            "probeType": 0,
            "configId": 47507,
            "probeProperty": 2,
            "probeAlarmStatus": 0
          }
        ],
        "subDeviceLastDataList": [
          {
            "dataTime": 1756204811000,
            "probeType": 0,
            "probeProperty": 2,
            "temperature": 24.7,
            "probeAlarmStatus": 0,
            "humidity": 56.8,
            "status": 0
          }
        ]
      },
      {
        "deviceRecord": {
          "buzzerStatus": 2,
          "productModel": "COEUS-WIFI",
          "userDeviceRecordId": 10512,
          "timeZone": "+08:00",
          "deviceSn": "250300479F",
          "deviceName": "250300479F",
          "dataCount": 0,
          "recordId": 12848,
          "uploadInterval": 1,
          "alarmStatus": 1,
          "recordStatus": 1,
          "collectInterval": 5,
          "temperatureUnit": 1,
          "parentDeviceName": "250300479F",
          "parentDeviceId": 2069,
          "parentDeviceSn": "250300479F",
          "startDelay": 0,
          "productType": 3
        },
        "sensorConfig": [
          {
            "parentId": 47394,
            "productCode": "94",
            "probeType": 1,
            "configId": 47395,
            "probeProperty": 0,
            "probeAlarmStatus": 0
          },
          {
            "parentId": 0,
            "productCode": "94",
            "probeType": 0,
            "configId": 47394,
            "probeProperty": 2,
            "probeAlarmStatus": 0
          }
        ],
        "subDeviceLastDataList": [
          {
            "probeType": 0,
            "probeProperty": 2,
            "probeAlarmStatus": 0
          }
        ]
      }
    ]
  },
  "msg": "success",
  "sign": "B03A56tGEUTRvHwW1sQKBef5ISoX/FuIRle8lVb6k5opFya0i3RrTSIWOctbgHmVGMAbDqawATKq7zxdnSH/DfutNc8C4I7kqldZYcLiwpaV577pdTyYA3/OOk6q2JOZMO9SnD1h5o8Wk+S+XSXg36W+51WmJWUDCVl6BkFoVG4mreOR5yK+274lEHBrzKsa5YuUB6Of8QO6kjGOWXeA+nV76geekAxNsoi+8JpQExoS4GtX74iaBrrZLIq6ClijhYaKOkxYonMEP0gZsv49JNlyn6eT88RHoN1y2evIjgy/zU0o81G9aX97iH3Ye6E8+aR4UPjeZUbjDpqL/5e3gg==",
  "subCode": "",
  "subMsg": ""
}

Obtain the Page of Sub-devices Under the Gateway

Interface Description

Obtain the page of sub-devices under the gateway Interface Method

gw.deviceInfo.subPage

Request Parameter

NameTypeRequiredDescriptionExample
userDeviceIdintYesUser device ID cannot be empty2230
deviceSnstringNoDevice ID201200000W
deviceNamestringNoDevice nameWarehouse 1
deviceStatusintNoDevice statusDevice status 0: Not activated 1: Online 2: Offline 3: Abnormal
alarmStatusintNoAlarm status1
keywordstringNoKeyword search
pageNumintYesPage number, starting from 11
pageSizeintYesData quantity each page, Max. 5020

Return Data

NameTypeRequiredDescriptionExample
tatalintYesTotal data quantity22
rowsarray[object]YesData
rows.subDeviceInfoobjectNoUser sub-device information
rows.subDeviceInfo.userDeviceIdintYesUser device ID
rows.subDeviceInfo.recordIdintYesRecord ID
rows.subDeviceInfo.deviceNamestringYesDevice name
rows.subDeviceInfo.deviceSnstringYesDevice ID
rows.subDeviceInfo.deviceStatusintYesDevice status
rows.subDeviceInfo.alarmStatusintYesAlarm status
rows.subDeviceInfo.productCodestringYesDevice type
rows.subDeviceInfo.productModelstringYesDevice model
rows.subDeviceInfo.devicePowerintNoDevice battery
rows.subDeviceInfo.collectIntervalintYesLogging interval
rows.subDeviceInfo.productPropertyintYesProduct property
1: Temperature
2: Temperature and humidity
3: Humidity
rows.subDeviceLastDataListarray[object]NoTemperature and humidity information of sub-devices
rows.subDeviceLastDataList.temperaturedoubleNoTemperature
rows.subDeviceLastDataList.humiditydoubleNoHumidity
rows.subDeviceLastDataList.lightdoubleNoIllumination
rows.subDeviceLastDataList.co2doubleNoCO2
rows.subDeviceLastDataList.dataTimelongNoData time
rows.subDeviceLastDataList.probeTypeintYesProbe type
0: Built-in
1: External probe 1
2: External probe 2
rows.subDeviceLastDataList.probePropertyintYesProbe property
0: Invalid
1: Temperature
2: Temperature and humidity
3: Illumination
4: CO2
rows.subDeviceLastDataList.probeAlarmStatusintYesProbe alarm status
0: Normal
1: Temperature alarm
2: Temperature and humidity alarm
3: Humidity alarm
rows.subDeviceLastDataList.probeAlarmTimelongNoProbe alarm time
rows.subDeviceLastDataList.statusintYesData status
0: Normal
1: The probe not connected or not connected properly
2: Mismatched probe type or malfunction

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceInfo.subPage",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
    "userDeviceId": "4525",
    "pageNum": 1,
    "pageSize": 2
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "subDeviceInfo": {
          "recordId": 12793,
          "productModel": "BlueTag T10-L",
          "alarmStatus": 1,
          "productCode": "007003",
          "collectInterval": 1,
          "productProperty": 1,
          "userDeviceId": 4543,
          "devicePower": 95,
          "deviceSn": "201200561U",
          "deviceName": "201200561U",
          "deviceStatus": 2
        },
        "subDeviceLastDataList": [
          {
            "dataTime": 1756342394000,
            "probeType": 0,
            "probeProperty": 1,
            "temperature": 28.3,
            "probeAlarmStatus": 0,
            "status": 0
          }
        ]
      }
    ]
  },
  "msg": "success",
  "sign": "O0E5aZdJJ0ySH4uHdMOWQ1SdRVYKh6jktlExOSWjXQUVFsY1L1CTVa4ifXiCyN7GHMVUHLYyo6kWfXC0tdB2siGUn13U5wLsFcae4t/DN+oX6PrTSxdAOKonqnYWUv6JT3TlxoAW+qJOSfsv9xDMWxubkPkMLVgo1zzklz3U4ECYm6J+Ux49d4yYqKeVIMw69p5TozxlOr15VJf/7tfkzqLX1lZ0diRgL+YoN9/IgYkbDt2+J3xZGJ2Pybf5MMukPRU8E2A+skHkcuks9iAbedBEx0DXS2+lX8cc+ndzghN0r50tB0MPVhXpvfwe1WK36ZHAw7NyDNfqHlnAPG/BYQ==",
  "subCode": "",
  "subMsg": ""
}

Obtain Device Configuration Information

Interface Description

Obtain device configuration informaiton.

Interface Method

gw.deviceInfo.get

Request Parameter

NameTypeRequiredDescriptionExample
userDeviceRecordIdintYesUser device record ID2230

Return Data

NameTypeRequiredDescription
subDeviceInfoobjectYesDevice information
subDeviceInfo.userDeviceIdintYesUser device ID
subDeviceInfo.recordIdintYes
Record ID
subDeviceInfo.parentIdintYes
Parent device ID
subDeviceInfo.deviceNamestringYes
Device name
subDeviceInfo.deviceSnstringYes
Device ID
subDeviceInfo.deviceStatusintYes
Device status
subDeviceInfo.statusTimelongYes
Device status time
subDeviceInfo.lastTimelongNoLast data time
subDeviceInfo.alarmStatusintYes
Alarm status
subDeviceInfo.alarmTimelongYes
Alarm time
subDeviceInfo.productModelstringYes
Device model
subDeviceInfo.devicePowerintNo
Device power
subDeviceInfo.powerStatusintYes
Power status
0:Not connected
1:Connected
subDeviceInfo.powerTimelongYes
Power time
subDeviceInfo.productCodeintYes
Device type
subDeviceInfo.configTimelongYes
Configuration time
subDeviceInfo.timeZonestringNoTime zone of the device
subDeviceInfo.temperatureUnitintNoTemperature unit
1: ℃
2: ℉
subDeviceInfo.buzzerStatusintNoBuzzer On/Off
1: On
2: Off
subDeviceInfo.collectIntervalintYesLogging interval
subDeviceInfo.uploadIntervalintYesUploading interval
subDeviceInfo.startDelayintNoStart delay
subDeviceInfo.recordStatusintYesRecord status
1: In use
2: Stopped
subDeviceInfo.productSceneintYesApplication
subDeviceInfo.productPropertyintNoProduct property
1: Temperature
2: Temperature and humidity
3: Humidity
subDeviceInfo.productTypeintYesProduct type
sensorAlarmListattay[object]NoAlarm point list
sensorAlarmList.alarmZonestringNoAlarm zone (High alarm: H; Low alarm: L)
sensorAlarmList.alarmPropertyintNoAlarm property
1: Temperature
2: Humidity
sensorAlarmList.probeTypeintNoProper type
0: Built-in
1: External probe 1
2: External probe 2
sensorAlarmList.alarmTypeintNoAlarm type
1: Low alarm
2: High alarm
sensorAlarmList.alarmWayintNoAlarm way
1: Single
2: Cumulative
sensorAlarmList.alarmDelayintNoAlarm delay
sensorAlarmList.alarmThresholddoubleNoAlarm threshold
sensorAlarmList.sortintNoAlarm point list (Starting from 1)
parentDeviceInfointNoParent device parameter
parentDeviceInfo.userDeviceIdintNoUser device ID of the gatewy
parentDeviceInfo.deviceSnstringNoGateway ID
parentDeviceInfo.deviceCodestringNoMac address of the gateway
parentDeviceInfo.deviceIdintNoDevice ID
sensorConfigInfoListarray[object]NoDevice configuration information
sensorConfigInfoList.probeTypeintNoProbe type
0: Built-in
1: External probe 1
2: External probe 2
sensorConfigInfoList.probePropertyintNoProperty property
0: Invalid
1: Temperature
2: Temperature and humidity
3: Humidity
sensorConfigInfoList.probeAlarmStatusintNoProbe alarm status
sensorConfigInfoList.probeAlarmTimelongNoProbe alarm time
sensorConfigInfoList.temHighdoubleNoMin. value of high temperature alarm
sensorConfigInfoList.temLowdoubleNoMax. value of low temperature alarm
sensorConfigInfoList.humHighdoubleNoMin. value of high humidity alarm
sensorConfigInfoList.humLowdoubleNoMax. value of low humidity alarm
sensorConfigInfoList.lightLowdoubleNoMax. value of low illumination alarm
sensorConfigInfoList.lightHighdoubleNoMin. value of high illumination alarm
sensorConfigInfoList.co2LowdoubleNoMax. value of low CO2 alarm
sensorConfigInfoList.co2HighdoubleNoMin. value of high CO2 alarm
sensorConfigInfoList.collectIntervalintNoLogging interval
sensorConfigInfoList.uploadIntervalintNoUploading interval
sensorConfigInfoList.startDelaydoubleNoStart delay
tripRecordDOobjectNoOrder information
tripRecordDO.idintNoTrip record ID
tripRecordDO.recordIdintNoRecord ID
tripRecordDO.tripIdintNoTrip ID
tripRecordDO.orderIdintNoOrder ID
tripRecordDO.remarkstringNoRemarks

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.deviceInfo.page",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 2
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 6,
    "rows": [
      {
        "deviceDeviceStateCount": {
          "alarmCount": 0,
          "onlineCount": 0,
          "offlineCount": 0,
          "deviceCount": 0,
          "abnormalCount": 0
        },
        "deviceInfo": {
          "productModel": "COEUS-WIFI",
          "userDeviceId": 4522,
          "deviceCode": "48E729574E22",
          "deviceId": 2069,
          "deviceSn": "250300479F",
          "deviceName": "250300479F",
          "deviceStatus": 2,
          "deleteFlag": true,
          "recordId": 12848,
          "alarmStatus": 1,
          "powerTime": "1755662900000",
          "productCode": "94",
          "manageFlag": 1,
          "productScene": 2,
          "userParentId": 4522,
          "statusTime": "1755662900000",
          "devicePower": 5,
          "productType": 3,
          "gatewaySn": "250300479F"
        },
        "subDeviceLastDataList": [
          {
            "probeType": 0,
            "probeProperty": 2,
            "probeAlarmStatus": 0
          }
        ]
      },
      {
        "deviceDeviceStateCount": {
          "alarmCount": 0,
          "onlineCount": 0,
          "offlineCount": 0,
          "deviceCount": 0,
          "abnormalCount": 0
        },
        "deviceInfo": {
          "productModel": "COEUS-WIFI",
          "userDeviceId": 4523,
          "deviceCode": "48E729577FC6",
          "deviceId": 2068,
          "deviceSn": "250300478F",
          "deviceName": "250300478F",
          "deviceStatus": 2,
          "deleteFlag": true,
          "recordId": 12847,
          "alarmStatus": 1,
          "powerTime": "1755662900000",
          "productCode": "94",
          "manageFlag": 1,
          "productScene": 2,
          "userParentId": 4523,
          "statusTime": "1755662900000",
          "devicePower": 5,
          "productType": 3,
          "gatewaySn": "250300478F"
        },
        "subDeviceLastDataList": [
          {
            "dataTime": "1755662900000",
            "probeType": 0,
            "probeProperty": 2,
            "probeAlarmStatus": 0,
            "status": 0
          }
        ]
      }
    ]
  },
  "msg": "success",
  "sign": "S7H2O+CaQEYZ7T5Wa3xsNqqTiqZvMsdbumwMR6+Z+R2LUqtqo7HlQCinNEaCvJvbSEYnSmoPU7CUlDpn7ws4Ap+KaXxB4WkKdPs96jpj95oCXFCiBMYPIhwCYqHKVOMlh96i8m/WtagSsiC0xRJR+iwoN2Spzl17CeuH0tM3TtVL2jT11JuZJPTxrBKun8XElM8lbeXf5XNtfDKuBvUE68jk8Zao7SKu4ve+lBW5yB+cGUeUUEaCxs6Hly4IeHRLZ2ir/oi0qE0L3efW43eeejqg3Bh3I53vAC0J9YdBhlzfVodbtQZlGGEu5aavWaf2aCoGkiFy2VsPtn8KftOCEw==",
  "subCode": "",
  "subMsg": ""
}

Obtain Alarm Notification Setting of the Devices

Interface Description

Obtain email and SMS alarm notifications of the gateway, COEUS or GSP devices.

Interface Method

gw.notifyConfig.get

Request Parameter

NameTypeRequiredDescriptionExample
userDeviceIdintYesUser device record ID2230

Return Data

NameTypeRequiredDescription
dataobjectYesNotification information
data.configIdintYesGateway configuration ID1222
data.notifyEmailFlagintYesEmail notification
1: Available
2: Not available
1
data.notifyDayEmailCountintNoEmail notifications to be sent per day3
data.notifyDayEmailNumintNoEmail notifications having been sent per day3
data.notifyEmailIntervalintNoEmail sending interval (minutes)30
data.notifySingleEmailCountintNoEmail notifications per device3
data.notifyAlarmEmailstringNoEmail address (split multiple addresses with ,)xjwl@xjwl.com
data.notifySmsFlagintYesSMS notifications
1: Available
2: Not available
1
data.notifyDaySmsCountintNoSMS notifications to be sent per day3
data.notifyDaySmsNumintNoSMS notifications having been sent per day3
data.notifySmsIntervalintNoSMS sending interval (Minutes)30
data.notifySingleSmsCountintNoSMS notifications per device3
data.notifyAlarmSmsstringNoMobile phone number (split multiple numbers with ,)+86-17***000000
data.notifyDatestringNoNotification date0,1,2,3
0 represents Sunday.
data.notifyStartTimestringNoStart time of the notification08:00
data.notifyEndTimestringNoEnd time of the notification23:00
data.notifyTimeFlagintYesTime notification flag
0: No settings by default
1: Email sending time
2: SMS notification based on the default time
3: Email and SMS notification based on the default time

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.notifyConfig.get",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
		userDeviceId: 1233
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "notifyEmailInterval": 30,
    "notifyAlarmSms": "",
    "notifyTimeFlag": 0,
    "notifyDayVoiceCount": 20,
    "notifySingleEmailCount": 1,
    "notifyVoiceFlag": 2,
    "notifyDaySmsCount": 20,
    "notifyDaySmsNum": 0,
    "notifyDayEmailNum": 0,
    "notifyEmailFlag": 2,
    "notifyStartTime": "0",
    "notifyEndTime": "0",
    "notifySingleSmsCount": 1,
    "notifySingleVoiceCount": 1,
    "notifyAlarmVoice": "",
    "notifyVoiceInterval": 30,
    "configId": 11793,
    "notifyDayVoiceNum": 0,
    "notifySmsInterval": 30,
    "notifySmsFlag": 2,
    "notifyAlarmEmail": "",
    "notifyDayEmailCount": 20
  },
  "msg": "success",
  "sign": "RQB8S3d2nQpXhM5Mvm2LY8PaYIcfZfCjm4znpAthuMUGpiueFA0+aFBDHESWOzeu68LPco4SaJq4k79e/4hxSCWkfedb5ZXWIMDtwYPTgr8ptXsU7Q3oBPjwRP2iI53m1MnLlen5O/Jl//JNTv+4a60/m9uM4xjuDrCKYcvMYwmL5dUoYMokhfi1MbOmojdRecmdIBekCQb/lV9HyTwNWGCo7ohn9+E+JKHMESbjfLFLewjWrLbBctbqvJImF07BVqZwme6nEiwagsLce7zPEWgQahPxSG2UbaYFJzQEsSTU/X2fdZbQkZzokDvDF43R7ObE+NjnZ7k+dSlob5Omwg==",
  "subCode": "",
  "subMsg": ""
}

Modify Alarm Notification Setting of the Devices

Interface Description

Modify email and SMS alarm notifications of the gateway, COEUS or GSP devices.

Interface Method

gw.notifyConfig.update

Request Parameter

NameTypeRequiredDescriptionExample
configIdintYesUser device record ID2230
notifyEmailFlagintYesEmail notification
1: Available
2: Not available
1
notifyDayEmailCountintNoEmail notifications to be sent per day1
notifyEmailIntervalintEmail sending interval (Minutes)30
notifySingleEmailCountintNoEmail notifications per alarm point1
notifyAlarmEmailstringNoEmail address (split multiple addresses with ,)The area code separated by -
notifySmsFlagintYesSMS notification
1: Available
2: Not available
1
notifyDaySmsCountintNoSMS notifications to be sent per day2
notifySmsIntervalintNoSMS sending interval (Minutes)30
notifySingleSmsCountintNoSMS notifications per alarm point1
notifyAlarmSmsstringNoMobile phone number (split multiple numbers with ,)The area code separated by -
notifyDatestringNoNotification date0,1,2,3
0 represents Sunday.
notifyStartTimestringNoStart time of the notification08:00
notifyEndTimestringNoEnd time of the notification18:00
notifyTimeFlagintYesTime notification flag
0: No settings by default
1: Email sending time
2: SMS notification
based on the default
time
3: Email and SMs
notification based on the default time
0

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success; false: Failedtrue

Example for Requesting Parameter

{
  "appId": "658409073956360262328652394",
  "method": "gw.notifyConfig.get",
  "signType": "RSA2",
  "timestamp": 1755662900000,
  "version": "1.0",
  "bizContent": {
		configId: 2223,
		notifyEmailFlag: 1,
		notifyDayEmailCount: 20,
		notifyEmailInterval: 30,
		notifySingleEmailCount: 3,
		notifyAlarmEmail: "4111@qq.com,2222@qq.com",
		notifySmsFlag: 1,
		notifyDaySmsCount: 20,
		notifySmsInterval: 30,
		notifySingleSmsCount: 3,
		notifyAlarmSms: "+86-1231111111,+24-12322222222",
		notifyVoiceFlag: 2,
		notifyTimeFlag: 0
  },
  "sign": "hFR2xeKVOhSIbRY8A8xrXWNY98B5kFaitoKuJXXfLsDvfeyjzfYIJkvyU2RcwYgb3L+s9aq7xfxz43K/Rx1u2QQiKt30UOS0R9Wd59gqkLVke1uV0d5n40zVX/aakt0G82IlFb4LhuTH1HuGkNfLCRWawP8uq+Q97frtrlRKmXie7zEdHtIIkbvCTOu52dASfSRIKxtr20FjAUuA/Hy/LiytUSvobM6ZycOvuvifGIOyumVTDgh1pmBc/pcP6tCTb5g2JPm6W1TY97zkIZojOH7awb579wLgdIqaACNTWQoUWLBX9xkK5HFksQhzYYIBz5NxC5PLME1LHFg82fFDw=="
}

Example for Returning Data

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