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

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

    • User information
    • User device
    • Device trip
    • Trip data
    • Device group
    • Grouped device
    • Configuration template
  • Webhook introduction

    • Webhook

Configuration Template Page

Interface Description

Obtain the configuration template page of user devices based on the query conditions.

Interface Method

tracker.configTemplate.page

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 1
1
pageSizeintYesPage size, 1-50 items10
templateNamestringNoTemplate nametemplate

Return Data

NameTypeRequiredDescriptionExample
totalintYesTotal number4
rowsarray[object]YesData list
tripConfigobjectYesTrip configuration information
tripConfig.templateNamestringYesTemplate nametemplate
tripConfig.tripConfigTemplateIdintYesTemplate ID45233
tripConfig.startDelayintYesStart delay (Unit: min)5
tripConfig.collectIntervalintYesLogging interval (Unit: min)5
tripConfig.activeTimeintYesUploading interval (Unit: min)5
tripConfig.buttonFlagintNoButton stop
0: Invalid
1: Valid
1
tripConfig.gpsFlagintNoGPS positioning
0: Off
1: On
1
tripConfig.wifiFlagintNoWiFi positioning
0: Off
1: On
1
tripConfig.flightFlagintNoFlight mode
0: Off
1: On
1
tripConfig.flightStartTimelongNoStart time of flight mode1747640566191
tripConfig.flightEndTimelongNoEnd time of flight mode1747640566191
tripConfig.lightFlagintNoLight detection
0: Off
1: On
0
tripConfig.shockFlagintNoVibration detection
0: Off
1: On
0
tripConfig.emailstringNoNotification emails (separated by ,)1@freshliance.com
tripConfig.phoneListarray[object]NoMobile phone number list
tripConfig.phoneList.areaCodestringNoMobile phone area code+86
tripConfig.phoneList.phonestringNoMobile phone number123456789
tripConfig.phoneList.enableSmsFlagintNoSMS notification
0: Off
1: On
1
tripConfig.phoneList.enableVoiceFlagintNoVoice call notification
0: Off
1: On
0
trackerPermissionobjectNoDevice tracking permission
trackerPermission.mapViewFlagintNoDevice tracking-Map preview
0: No
1: Yes
1
trackerPermission.dataChartFlagintNoDevice tracking -Data graphing
0: No
1: Yes
1
trackerPermission.dataListFlagintNoDevice tracking - Data tabulating
0: No
1: Yes
1
trackerPermission.basicInfoFlagintNoDevice tracking - Basic information display
0: No
1: Yes
1
trackerPermission.alarmInfoFlagintNoDevice tracking - Alarm point setting 0: No 1: Yes1
trackerPermission.pdfExportFlagintNoDevice tracking - pdf data report
0: No
1: Yes
1
trackerPermission.csvExportFlagintNoDevice tracking - csv data report
0: No
1: Yes
1
alarmListarray[object]NoAlarm setting list
alarmList.probeTypeintNoProbe type
0: Built-in
1: External
0
alarmList.alarmZonestringNoAlarm point (High/low alarm+ Serial number)
H1: High alarm 1
L2: Low alarm 2
H1
alarmList.propertyTypeintNoProperty type
0: Temperature
1: Humidity
2: Light
3: Vibration
1
alarmList.alarmTypeintNoAlarm type
0: Low alarm
1: High alarm
1
alarmList.alarmWayintNoAlarm way
0: Single
1: Cumulative
0
alarmList.alarmDelayintNoAlarm delay (Unit: min)
Range: 0~9999
10
alarmList.thresholddoubleNoAlarm threshold (Unit: Temperature: ℃; Humidity: %RH)60
warnListarray[object]NoEarly warning setting list
warnList.probeTypeintNoProbe type
0: Built-in
1: External
0
warnList.temLowLimitdoubleNoTemperature lower than the threshold: Trigger off early warning when the temperature is lower than the threshold0
warnList.temHighLimitdoubleNoTemperature higher than the threshold: Trigger off early warning when the temperature is higher than the threshold30
warnList.humLowLimitdoubleNoHumidity lower than the threshold: Trigger off early warning when the humidity is lower than the threshold10
warnList.humHighLimitdoubleNoHumidity higher than the threshold: Trigger off early warning when the humidity is higher than the threshold60
warnList.smsSendCountintNoThe number of SMS messages sent per day10
warnList.emailSendCountintNoThe number of Email messages sent per day10
warnList.smsSingleSendCountintNoThe number of SMS messages sent for a single alarm3
warnList.emailSingleSendCountintNoThe number of Email messages sent for a single alarm3
warnList.smsSendIntervalintNoSMS sending interval (Min)30
warnList.emailSendIntervalintNoEmail sending interval (Min)30
warnList.weekIdsstringNoCharacter string of the days of week, 1,2,3,4,5,6,7, separated by ,1,2,3,4,5,6,7
warnList.startPeriodTimeStrstringNoStart time character string of the alarm period: 00:00 - 23:5900:00
warnList.endPeriodTimeStrstringNoEnd time character string of the alarm period: 00:00 - 23:5923:59

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.configTemplate.page",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747882583352",
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 10
  },
  "sign": "EPUbuUmDubTQ47ITUSEqJpKTFNNYMw00NUy4lECF3l4VE6PdjL3KI/F4O+6Iz5usH0QlhzFWzLPLQ1C5shKwU9cPmg/f4XV0wM8HNb+BaF8HGAni3dfIl6AnJC4dHp+8esIy6bPIePArYhz6nuIcZcSkjbgeOk0svlwCBC7UOHtCYFxO0K2iVReEKAGTmBtu2w55R4NbwUyl/gJ1biCjygkiIRdyX8caLIElZthxv/eOe+LaHEVWgudgPoFckZkQgwdVFnoWj4ykSvw6T7dWtwuPLeMZyLclfYNIZDWwJMpi2ABVyqs4kCxv9Ny8JQlx2Z+oekD6TlftBZ1bapfJMQ=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "warnList": [
          {
            "startPeriodTimeStr": "07:00",
            "weekIds": "1,2,3,4,6",
            "smsSendCount": 2,
            "emailSendCount": -1,
            "temHighLimit": 20,
            "emailSendInterval": 5,
            "smsSingleSendCount": 3,
            "humHighLimit": 20,
            "smsSendInterval": 5,
            "probeType": 0,
            "emailSingleSendCount": 3,
            "endPeriodTimeStr": "23:59",
            "temLowLimit": 10,
            "humLowLimit": 10
          },
          {
            "startPeriodTimeStr": "00:00",
            "weekIds": "1,2,3,4,5,6,7",
            "smsSendCount": 2,
            "emailSendCount": 3,
            "emailSendInterval": 5,
            "smsSingleSendCount": 3,
            "humHighLimit": 50,
            "smsSendInterval": 5,
            "probeType": 1,
            "emailSingleSendCount": 2,
            "endPeriodTimeStr": "23:59",
            "temLowLimit": 26,
            "humLowLimit": 1
          }
        ],
        "trackerPermission": {
          "csvExportFlag": 1,
          "basicInfoFlag": 1,
          "mapViewFlag": 1,
          "pdfExportFlag": 1,
          "dataListFlag": 1,
          "alarmInfoFlag": 1,
          "dataChartFlag": 1
        },
        "alarmList": [
          {
            "alarmZone": "H1",
            "alarmType": 1,
            "probeType": 0,
            "propertyType": 0,
            "threshold": 30,
            "alarmDelay": 0,
            "alarmWay": 0
          },
          {
            "alarmZone": "L2",
            "alarmType": 0,
            "probeType": 0,
            "propertyType": 0,
            "threshold": 27,
            "alarmDelay": 0,
            "alarmWay": 0
          }
        ],
        "tripConfig": {
          "gpsFlag": 0,
          "buttonFlag": 1,
          "activeTime": 5,
          "flightFlag": 0,
          "shockFlag": 0,
          "wifiFlag": 0,
          "collectInterval": 1,
          "templateName": "template",
          "tripConfigTemplateId": 2609,
          "startDelay": 0,
          "lightFlag": 0,
          "email": "feedback@freshliance.com"
        }
      }
    ]
  },
  "msg": "success",
  "sign": "VKZXQapPIQLJ1s+W/jy1on2+mxyCmRzXq1jEbQp/qPxi7cQikMrS0Xm5uTDAbePafYOmf6lGZPzx0LmXfkdWXa6jjrvQwC3Ck9LPyuTCPNRsOmQQXQd7ByuRCzMdBsxOwOpmqR5G6eqWpP98upmQ5nIlcF0QZwsUIvPXfyh4EHfz5GJ7jsH5t7TpUjbdJEEXPIN3iWa0mLDt3NsFMEb+jEPTCj90/Sl48bVafSd69KFTgO6uTHlAOL5xYUsCdpdWnqIK0qfntknNVvHUIxh6KJSr4GD0IgSOr7LK+/D4ynbHnP7arw3zIbMwp+pIbspTjug6+jxxpchnlxzmXCq9aA==",
  "subCode": "",
  "subMsg": ""
}

Obtain Trip Template

Interface Description

Obtain trip template details based on trip template ID.

Interface Method

tracker.configTemplate.get

Request Parameter

NameTypeRequiredDescriptionExample
tripConfigTemplateIdintYesTrip configuration template ID2557

Return Data

NameTypeRequiredDescriptionExample
tripConfigobjectTrip configuration information
tripConfig.templateNamestringYesTemplate nametemplate
tripConfig.startDelayintYesStart delay (Unit: min)5
tripConfig.collectIntervalintYesLogging interval (Unit: min)5
tripConfig.activeTimeintYesUploading interval (Unit: min)5
tripConfig.buttonFlagintNoButton stop
0: Invalid
1: Valid
1
tripConfig.gpsFlagintNoGPS positioning
0: Off
1: On
1
tripConfig.wifiFlagintNoWiFi positioning
0: Off
1: On
1
tripConfig.flightFlagintNoFlight mode
0: Off
1: On
0
tripConfig.flightStartTimelongNoStart time of flight mode1747640566191
tripConfig.flightEndTimelongNoEnd time of flight mode1747640566191
tripConfig.lightFlagintNoLight detection
0: Off
1: On
0
tripConfig.shockFlagintNoVibration detection
0: Off
1: On
0
tripConfig.emailstringNoNotification emails (separated by ,)1@freshliance.com
tripConfig.phoneListarray[object]NoMobile phone number list
tripConfig.phoneList.areaCodestringNoMobile phone area code+86
tripConfig.phoneList.phonestringNoMobile phone number123456789
tripConfig.phoneList.enableSmsFlagintNoSMS notification
0: Off
1: On
1
tripConfig.phoneList.enableVoiceFlagintNoVoice call notification
0: Off
1: On
0
trackerPermissionobjectYesDevice tracking permission
trackerPermission.mapViewFlagintYesDevice tracking-Map preview
0: No
1: Yes
1
trackerPermission.dataChartFlagintYesDevice tracking -Data graphing
0: No
1: Yes
1
trackerPermission.dataListFlagintYesDevice tracking - Data tabulating
0: No
1: Yes
1
trackerPermission.basicInfoFlagintYesDevice tracking - Basic information
0: No
1: Yes
1
trackerPermission.alarmInfoFlagintYesDevice tracking - Alarm point setting
0: No
1: Yes
1
trackerPermission.pdfExportFlagintYesDevice tracking - pdf data report
0: No
1: Yes
1
trackerPermission.csvExportFlagintYesDevice tracking - csv data report
0: No
1: Yes
1
alarmListarray[object]NoAlarm setting list
alarmList.probeTypeintNoProbe type
0: Built-in
1: External
0
alarmList.alarmZonestringNoAlarm point (High/low alarm+Serial number)
H1: High alarm 1
L2: Low alarm 2
H1
alarmList.propertyTypeintNoProperty type
0: Temperature
1: Humidity
2: Light
3: Vibration
1
alarmList.alarmTypeintNoAlarm type
0: Low alarm
1: High alarm
1
alarmList.alarmWayintNoAlarm way
0: Single
1: Cumulative
0
alarmList.alarmDelayintNoAlarm delay (Unit: min)
Range: 0~9999
10
alarmList.thresholddoubleNoAlarm threshold (Unit: Temperature: ℃; Humidity: %RH)60
warnListarray[object]Early warning setting list
warnList.probeTypeintNoProbe type
0: Built-in
1: External
0
warnList.temLowLimitdoubleNoTemperature lower than the threshold: Trigger off early warning when the temperature is lower than the threshold0
warnList.temHighLimitdoubleNoTemperature higher than the threshold: Trigger off early warning when the temperature is higher than the threshold30
warnList.humLowLimitdoubleNoHumidity lower than the threshold: Trigger off early warning when the humidity is lower than the threshold10
warnList.humHighLimitdoubleNoHumidity higher than the threshold: Trigger off early warning when the humidity is higher than the threshold60
warnList.smsSendCountintNoThe number of SMS messages sent per day10
warnList.emailSendCountintNoThe number of Email messages sent per day10
warnList.smsSingleSendCountintNoThe number of SMS messages sent for a single alarm3
warnList.emailSingleSendCountintNoThe number of Email messages sent for a single alarm3
warnList.smsSendIntervalintNoSMS sending interval (Min)30
warnList.emailSendIntervalintNoEmail sending interval (Min)30
warnList.weekIdsstringNoCharacter string of the days of week, MON, TUE, WED, THU, FRI, SAT and SUN correspond to 1,2,3,4,5,6,7, separated by ,1,2,3,4,5,6,7
warnList.startPeriodTimeStrstringNoStart time character string of the alarm period: 00:00 - 23:5900:00
warnList.endPeriodTimeStrstringNoEnd time character string of the alarm period: 00:00 - 23:5923:59

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.configTemplate.get",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747881078203",
  "version": "1.0",
  "bizContent": {
    "tripConfigTemplateId": 2822
  },
  "sign": "A3G30AufRwg4JNcmZVGBiKPe9Q2+l61t8fJtpiWJPp2WHIwXFlvoTZHY0BFTPuEnc4pdukoOWp2Y7lHFFz96V1gWWpXSZihxay2thXEypcBbG5esER4r68npWI9BCB8hH91er+BVHrN1Ut2RN9IqGMSrS8m29BVS+p7DdudmsaFFKIkVwDsYtRadkWK10X98tuttUchQ8JNiaHaITr/RFiM2hZHRSwn3F7oMpWxU7rElospx8L6nJNkxU5VpdriEFMbeOf696YxgU8rol3PGs0UWW+FEmGH9nNSOVJsm/EnQ7bWxPoWAXisoh5EQnAG+Hc7Q6KaamZYszDJjAsy2qA=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "warnList": [
      {
        "startPeriodTimeStr": "07:00",
        "weekIds": "1,2,3,4,6",
        "smsSendCount": 2,
        "emailSendCount": -1,
        "temHighLimit": 20,
        "emailSendInterval": 5,
        "smsSingleSendCount": 3,
        "humHighLimit": 20,
        "smsSendInterval": 5,
        "probeType": 0,
        "emailSingleSendCount": 3,
        "endPeriodTimeStr": "23:59",
        "temLowLimit": 10,
        "humLowLimit": 10
      },
      {
        "startPeriodTimeStr": "00:00",
        "weekIds": "1,2,3,4,5,6,7",
        "smsSendCount": 2,
        "emailSendCount": 3,
        "emailSendInterval": 5,
        "smsSingleSendCount": 3,
        "humHighLimit": 50,
        "smsSendInterval": 5,
        "probeType": 1,
        "emailSingleSendCount": 2,
        "endPeriodTimeStr": "23:59",
        "temLowLimit": 26,
        "humLowLimit": 1
      }
    ],
    "trackerPermission": {
      "csvExportFlag": 1,
      "basicInfoFlag": 1,
      "mapViewFlag": 1,
      "pdfExportFlag": 1,
      "dataListFlag": 1,
      "alarmInfoFlag": 1,
      "dataChartFlag": 1
    },
    "alarmList": [
      {
        "alarmZone": "H1",
        "alarmType": 1,
        "probeType": 0,
        "propertyType": 0,
        "threshold": 30,
        "alarmDelay": 0,
        "alarmWay": 0
      },
      {
        "alarmZone": "H2",
        "alarmType": 1,
        "probeType": 1,
        "propertyType": 1,
        "threshold": 50,
        "alarmDelay": 2,
        "alarmWay": 0
      }
    ],
    "tripConfig": {
      "gpsFlag": 0,
      "buttonFlag": 1,
      "activeTime": 5,
      "flightFlag": 0,
      "phoneList": [
        {
          "areaCode": "+86",
          "phone": "123456789",
          "enableVoiceFlag": 0,
          "enableSmsFlag": 1
        }
      ],
      "shockFlag": 0,
      "wifiFlag": 0,
      "collectInterval": 1,
      "templateName": "hh",
      "tripConfigTemplateId": 2609,
      "startDelay": 0,
      "lightFlag": 0,
      "email": "feedback@freshliance.com"
    }
  },
  "msg": "success",
  "sign": "B0W8bCtTwEjE6OsxulpHCcFZDXQlSdQoJwQFpn79RgoYAJCZ0Z2ZabBtY+b+0pGf7inAAt9ctSTHmaeq8LG4XeiCn7Mg4I6+2116mQ7XoCWQpuHxgdm9gb+3ZXaW2rE4M7qPYx1pWZcgW/3o+qCskbbA7qSNBVTOL3qF+5ZxYUDlwrHYtssuGpGYWKkf2bRen00n8iTHxxyY0GgP/cl2mnJVc8v8VwKr1txHvjiefA9iXUMHXZYdqHZ+XbFsSVIYwd6d4b/43zN1fTOvUrNdf6aMpPM3NwkE+783gmel2n+VDUx3fr3uYxX5V1fteqwdzWIj0JjsJfkd8AFroAaU0g==",
  "subCode": "",
  "subMsg": ""
}

Add A New Trip Template

Interface Description

Add a new trip template.

Interface Method

tracker.configTemplate.create

Request Parameter

NameTypeRequiredDescriptionExample
tripConfigobjectYesTrip configuration information
tripConfig.templateNamestringYesTemplate nametemplate
tripConfig.startDelayintYesStart delay (Unit: min) 0/5/10/20/30/60/120/2405
tripConfig.collectIntervalintYesLogging interval (Unit: min) 1/2/5/10/20/30/60/1205
tripConfig.activeTimeintYesUploading interval (Unit: min)
5/10/20/30/60/120/240/480
5
tripConfig.buttonFlagintNoButton stop
0: Invalid
1: Valid
1
tripConfig.gpsFlagintNoGPS positioning
0: Off
1: On
1
tripConfig.wifiFlagintNoWiFi positioning
0: Off
1: On
1
tripConfig.flightFlagintNoFlight mode
0: Off
1: On
0
tripConfig.flightStartTimelongNoStart time of flight mode1747640566191
tripConfig.flightEndTimelongNoEnd time of flight mode1747640588653
tripConfig.lightFlagintNoLight detection
0: Off
1: On
0
tripConfig.shockFlagintNoVibration detection
0: Off
1: On
0
tripConfig.emailstringNoNotification emails, Max. 3 email addresses (separated by English punctuation mark ,), max. 500 characters1@freshliance.com
tripConfig.phoneListarray[object]Mobile phone number list
tripConfig.phoneList.areaCodestringNoMobile phone area code+86
tripConfig.phoneList.phonestringNoMobile phone number123456789
tripConfig.phoneList.enableSmsFlagintNoSMS notification
0: Off
1: On
1
tripConfig.phoneList.enableVoiceFlagintNoVoice call notification
0: Off
1: On
1
trackerPermissionobjectDevice tracking permission
trackerPermission.mapViewFlagintYesDevice tracking-Map preview
0: No
1: Yes
1
trackerPermission.dataChartFlagintYesDevice tracking -Data graphing
0: No
1: Yes
1
trackerPermission.dataListFlagintYesDevice tracking - Data tabulating
0: No
1: Yes
1
trackerPermission.basicInfoFlagintYesDevice tracking - Basic information display
0: No
1: Yes
1
trackerPermission.alarmInfoFlagintYesDevice tracking - Alarm point setting
0: No
1: Yes
1
trackerPermission.pdfExportFlagintYesDevice tracking - pdf data report
0: No
1: Yes
1
trackerPermission.csvExportFlagintYesDevice tracking - csv data report
0: No
1: Yes
1
alarmListarray[object]Alarm setting list, Max. 6 alarm settings
alarmList.probeTypeintNoProbe type
0: Built-in
1: External
0
alarmList.propertyTypeintNoProperty type
0: Temperature
1: Humidity
2: Light
3: Vibration
1
alarmList.alarmTypeintNoAlarm type
0: Low alarm
1: High alarm
1
alarmList.alarmWayintNoAlarm way
0: Single
1: Cumulative
0
alarmList.alarmDelayintNoAlarm delay (Unit: min)
Range: 0~9999
10
alarmList.thresholddoubleNoAlarm threshold (Unit: Temperature: ℃; Humidity: %RH)60
warnListarray[object]Early warning setting list
warnList.probeTypeintNoProbe type
0: Built-in
1: External
0
warnList.temLowLimitdoubleNoTemperature lower than the threshold: Trigger off early warning when the temperature is lower than the threshold0
warnList.temHighLimitdoubleNoTemperature higher than the threshold: Trigger off early warning when the temperature is higher than the threshold30
warnList.humLowLimitdoubleNoHumidity lower than the threshold: Trigger off early warning when the humidity is lower than the threshold10
warnList.humHighLimitdoubleNoHumidity higher than the threshold: Trigger off early warning when the humidity is higher than the threshold60
warnList.smsSendCountintNoThe number of SMS messages sent per day: -1~20 -1 indicates no restriction.10
warnList.emailSendCountintNoThe number of Email messages sent per day: -1~20 -1 indicates no restriction.10
warnList.smsSingleSendCountintNoThe number of SMS messages sent for a single alarm:
1/2/3
3
warnList.emailSingleSendCountintNoThe number of Email messages sent for a single alarm:
1/2/3
3
warnList.smsSendIntervalintNoSMS sending interval (Min): 5,10,15,30,6030
warnList.emailSendIntervalintNoEmail sending interval (Min): 5,10,15,30,6030
warnList.weekIdsstringNoAlarm period, the days of week (separated by English punctuation mark ,) MON, TUE, WED, THU, FRI, SAT and SUN respectively correspond to 1,2,3,4,5,6,7.1,2,3,4,5,6,7
warnList.startPeriodTimeStrstringNoStart time character string of the alarm period: 00:00 - 23:5900:00
warnList.endPeriodTimeStrstringNoEnd time character string of the alarm period: 00:00 - 23:5923:59

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success false: Failedtrue

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.configTemplate.create",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747884515699",
  "version": "1.0",
  "bizContent": {
    "trackerPermission": {
      "alarmInfoFlag": 1,
      "basicInfoFlag": 1,
      "csvExportFlag": 1,
      "dataChartFlag": 1,
      "dataListFlag": 1,
      "mapViewFlag": 1,
      "pdfExportFlag": 1
    },
    "tripConfig": {
      "activeTime": 5,
      "buttonFlag": 1,
      "collectInterval": 1,
      "email": "feedback@freshliance.com",
      "flightFlag": 0,
      "gpsFlag": 1,
      "lightFlag": 0,
      "phoneList": [
        {
          "areaCode": "+86",
          "enableSmsFlag": 1,
          "enableVoiceFlag": 1,
          "phone": "123456789"
        }
      ],
      "shockFlag": 0,
      "startDelay": 5,
      "templateName": "template",
      "wifiFlag": 1
    }
  },
  "sign": "ge2qPdTPI6THNaMBW/60npkexTFTjdP879/ZSWLgJP1l0kTVKGVqt3630A+bAIGnqe+7Umxcr2nZHr/1DHzvpi6eb0uN0CZohcJSkMqzYsCraFQ/V4C13SmEwoBxVD1N2YF3umKyIkMrVQh0htvecEWDhGhY/Ht8g9woiFJcSiuN1A7peI+K/lAlVHekW211t74ZHWm2wVsQ3LHz6T3Asq88L/BiCQbWCNCDripnRT0UlNl45hFBUhbYj+AsTQAkB7XnLxaHrTvXRvi9RZnJaKapzB7hHvOrvgzoPNlHO/UnPVZK8YTZ+usoz6IKiFaW1gXlD1WLTi6Z22A8h1N4Ww=="
}

Example for Returning Data

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

Modify Trip Template

Interface Description

Modify trip template

Interface Method

tracker.configTemplate.update

Request Parameter

NameTypeRequiredDescriptionExample
tripConfigTemplateIdintYesTrip configuration template id6345
tripConfigobjectTrip configuration information
tripConfig.templateNamestringYesTemplate nametemplate
tripConfig.startDelayintYesStart delay (Unit: min) 0/5/10/20/30/60/120/2400
tripConfig.collectIntervalintYesLogging interval (Unit: min) 1/2/5/10/20/30/60/1201
tripConfig.activeTimeintYesUploading interval (Unit: min
5/10/20/30/60/120/240/480
5
tripConfig.buttonFlagintNoButton stop
0: Invalid
1: Valid
1
tripConfig.gpsFlagintNoGPS positioning
0: Off
1: On
0
tripConfig.wifiFlagintNoWiFi positioning
0: Off
1: On
1
tripConfig.flightFlagintNoFlight mode
0: Off
1: On
1
tripConfig.flightStartTimelongNoStart time of flight mode1747640566191
tripConfig.flightEndTimelongNoEnd time of flight mode1747640588653
tripConfig.lightFlagintNoLight detection
0: Off
1: On
1
tripConfig.shockFlagintNoVibration detection
0: Off
1: On
1
tripConfig.emailstringNotification emails, Max. 3 email addresses (separated by English punctuation mark,), Max. 500 characters1@freshliance.com
tripConfig.phoneListarray[object]NoMobile phone number list, Max. 3 phone numbers
tripConfig.phoneList.areaCodestringNoMobile phone area code+86
tripConfig.phoneList.phonestringNoMobile phone number13881234412
tripConfig.phoneList.enableSmsFlagintNoSMS notification
0: Off
1: On
1
tripConfig.phoneList.enableVoiceFlagintNoVoice call notification
0: Off
1: On
0
trackerPermissionobjectYesDevice tracking permission
trackerPermission.mapViewFlagintYesDevice tracking-Map preview
0: No
1: Yes
1
trackerPermission.dataChartFlagintYesDevice tracking -Data graphing
0: No
1: Yes
1
trackerPermission.dataListFlagintYesDevice tracking - Data tabulating
0: No
1: Yes
1
trackerPermission.basicInfoFlagintYesDevice tracking - Basic information display
0: No
1: Yes
1
trackerPermission.alarmInfoFlagintYesDevice tracking - Alarm point setting
0: No
1: Yes
1
trackerPermission.pdfExportFlagintYesDevice tracking - pdf data report
0: No
1: Yes
1
trackerPermission.csvExportFlagintYesDevice tracking - csv data report
0: No
1: Yes
1
alarmListarray[object]NoAlarm setting list, Max. 6 alarm settings
alarmList.probeTypeintNoProbe type
0: Built-in
1: External
0
alarmList.propertyTypeintNoProperty type
0: Temperature
1: Humidity
2: Light
3: Vibration
1
alarmList.alarmTypeintNoAlarm type
0: Low alarm
1: High alarm
0
alarmList.alarmWayintNoAlarm way
0: Single
1: Cumulative
0
alarmList.alarmDelayintNoAlarm delay (Unit: min)

Range: 0~9999
0
alarmList.thresholddoubleNoAlarm threshold (Unit: Temperature: ℃; Humidity: %RH)20
warnListarray[object]NoEarly warning setting list
warnList.probeTypeintNoProbe type
0: Built-in
1: External
0
warnList.temLowLimitdoubleNoTemperature lower than the threshold: Trigger off early warning when the temperature is lower than the threshold0
warnList.temHighLimitdoubleNoTemperature higher than the threshold: Trigger off early warning when the temperature is higher than the threshold30
warnList.humLowLimitdoubleNoHumidity lower than the threshold: Trigger off early warning when the humidity is lower than the threshold10
warnList.humHighLimitdoubleNoHumidity higher than the threshold: Trigger off early warning when the humidity is higher than the threshold60
warnList.smsSendCountintNoThe number of SMS messages sent per day: -1~20                               -1 indicates no restriction3
warnList.emailSendCountintNoThe number of Email messages sent per day: -1~20               -1 indicates no restriction.3
warnList.smsSingleSendCountintNoThe number of SMS messages sent for a single alarm:
 1/2/3
1
warnList.emailSingleSendCountintNoThe number of Email messages sent for a single alarm:
1/2/3
1
warnList.smsSendIntervalintNoSMS sending interval (Min): 5,10,15,30,605
warnList.emailSendIntervalintNoEmail sending interval (Min): 5,10,15,30,605
warnList.weekIdsstringNoAlarm period, the days of week (separated by English punctuation mark ,) MON, TUE, WED, THU, FRI, SAT and SUN respectively correspond to 1,2,3,4,5,6,7.1,2,3,4,5,6,7
warnList.startPeriodTimeStrstringNoStart time character string of the alarm period: 00:00 - 23:5900:00
warnList.endPeriodTimeStrstringNoEnd time character string of the alarm period: 00:00 - 23:5923:59

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success; false: Failedtrue

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.configTemplate.delete",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747885345966",
  "version": "1.0",
  "bizContent": {
    "trackerPermission": {
      "alarmInfoFlag": 1,
      "basicInfoFlag": 1,
      "csvExportFlag": 1,
      "dataChartFlag": 1,
      "dataListFlag": 1,
      "mapViewFlag": 1,
      "pdfExportFlag": 1
    },
    "tripConfig": {
      "activeTime": 5,
      "buttonFlag": 1,
      "collectInterval": 1,
      "email": "123@freshliance.com",
      "flightFlag": 0,
      "gpsFlag": 1,
      "lightFlag": 0,
      "phoneList": [
        {
          "areaCode": "+86",
          "enableSmsFlag": 1,
          "enableVoiceFlag": 1,
          "phone": "987654321"
        }
      ],
      "shockFlag": 0,
      "startDelay": 5,
      "templateName": "template1",
      "wifiFlag": 1
    },
    "tripConfigTemplateId": 3033
  },
  "sign": "SGnNGPg94YgJYyScb4jpn87gF6rWrzYjLXpWCt8MDVP1tjhS98pBWl+Skjt32QwMxTDFah8ceXW4WlycVJ3eZ5oow9OsrixkUNHhqMhiTEox0knJwv11dmSfvYq2Nr9o7NPVS6sJL4UzW5OHomuBFScyOBT7lBD9vwt+6QOs8m+Fg/WtaDDF8RgXbdsZ4nHUS8HbuvrJaY7mrTgVvUvw2FtSH5b80t/sfE+qnkhtVwo8rKUOA//5GRI4AOQpGPXqEez6cWneBxVk5Cn90VjCLIx0zeCuirsTBUSbi22vwqXK6nZ1ekRzR2e0ZQDjQhbo5qMR+qw5uWr0Mc6dWfRirA=="
}

Example for Returning Data

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

Delete Trip Template

Interface Description

Delete trip template

Interface Method

tracker.configTemplate.delete

Request Parameter

NameTypeRequiredDescriptionExample
tripConfigTemplateIdintYesTrip configuration template id3125

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success; false: Failedtrue

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.configTemplate.delete",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747884691678",
  "version": "1.0",
  "bizContent": {
    "tripConfigTemplateId": 3125
  },
  "sign": "bNuPj0JmgJE2yRVcFQYOSHk9kDGk+BNq3UEbvk3bQAxVI9sQvE02nT7UZrjOau6kaMpjDNRAScM7e06ybyEVu3Q3oigALt+Rv5LFNa3R1E7fX0sen/idbKR0dN7m8ocGWQhSUusqL6IenlfFPch1RCWF2MqH+98HD3+aK3CIsM10fqHYJyHzsmfxVWoYT4Ryk2aFDc4Ez6JBh5UhufXc5nNNScG8eB+oJplJRyTqcRpDA/13J37llOLt+opz3Z1dFFNARnEDg4+Gwj1KcGstUL/UsMQJ2VcUgpw8PpaD7UD4MHj+FwG6FhIkgFao4Mnqkzm+sa5NHl2CVPQ5vRl1Eg=="
}

Example for Returning Data

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