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

Group Page for Assigned Devices

Interface Description

Obtain the page of assigned devices based on the query conditions.

Interface Method

tracker.groupDevice.pageAllocatedDevice

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 11
pageSizeintYesPage size, 1-50 items10
userGroupIdintYesGroup ID125
deviceCodestringNoDevice code250700097T
tripCodestringNoWaybill numbertripCode
deviceStatusstringNoDevice status
online: Online
offline: Offline
online

Return Data

NameTypeRequiredDescriptionExample
totalintYesTotal number1
rowsarray[object]YesData list
rows.userGroupDeviceIdintYesUser group device id646
rows.userDeviceIdintYesDevice ID686
rows.deviceCodestringYesDevice code200700090T
rows.deviceTypestringYesDevice typeTracker10
rows.tripStatusstringYesTrip status
wait: Waiting to start
ing: Recording
end: Stopped
ing
rows.alarmFlagintYesTrip alarm mark
0: No alarm
1: Alarm
0
rows.deviceStatusstringYesDevice status
online: Online
offline: Offline
offline
rows.customNamestringNoUser-defined device nameorange
rows.tripCodestringNoTrip codetripCode
rows.goodsNamestringNoGoods nameorange
rows.expectedBeginTimelongNoExpected start time1747640566191
rows.expectedEndTimelongNoExpected end time1747640588653

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.groupDevice.pageAllocatedDevice",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747640566191",
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 10,
    "userGroupId": 186
  },
  "sign": "b5hjSZwQR0Vw014fKfremt9SMhDbCOCna3QcR3VjlC9/2NEuexwUNgJeuwb3FrRkQNUvI52GHMA+3nTfoqZQElGdwR8+ysBcBX86XLwnJhi3G6SZZdJjXqImhXDJlY0fuh85eHly9dxlSuEcp23AYOZevYdWcFzdg8Yl43dKFfrr4+joBWI4vk/mDBTZYx0hCN1x6mS1ArQmeu3vzhHP3qzd6qjoenlIFOI0wusdfE4T91V+OW6a/zI5lS4cwMPJzTcmJo/gx9ARdt0Ogw4N+d2Jp+6BOow1reEWrIwWvT+gV+czvyYVwwX1Yaa4WSTR/d9Ut9fE1a3k4r7X8OlkEg=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 2,
    "rows": [
      {
        "deviceType": "Tracker10",
        "customName": "Fresh Tracker10",
        "deviceCode": "240701311T",
        "userDeviceId": 533,
        "alarmFlag": "0",
        "deviceStatus": "offline",
        "tripCode": "pearCode",
        "userGroupDeviceId": 636,
        "goodsName": "pear",
        "tripStatus": "ing",
        "expectedBeginTime": 1747640566191,
        "expectedEndTime": 1747640588653
      },
      {
        "deviceType": "Tracker10-ETU",
        "customName": "Fresh Tracker10-ETU",
        "deviceCode": "240701298T",
        "userDeviceId": 713,
        "alarmFlag": "1",
        "deviceStatus": "offline",
        "tripCode": "",
        "userGroupDeviceId": 635,
        "goodsName": "",
        "tripStatus": "ing",
        "expectedBeginTime": 1747640566191,
        "expectedEndTime": 1747640588653
      }
    ]
  },
  "msg": "success",
  "sign": "gF5yKGAbfvN8ubMnPGQPaNHKqd2j2esecgSy64GDUVZwXle7TYbRVlqwPPzkF9yRu1EuNPRp9kKFOAgQdKIiCMOVjLqQqDPGLDxgpnJwlAzI88xunQmTSEsmiVEmtSFao9qCFszwjLj0f5eaDj9dnqxgMN2FDfCozEfDvDMqdrAGCCEJSFF6fsOGs1wiQC2s2Olbhld+Cs57XuA36s2pk7KVz58T4dqqRBdktH+qmmZFNQykOob8YTGhfqgx7HVzyTLeC4Fd9nilWcvhblV8SaRbCq76VEdAWGP/un/ABTYabIAxP00p8ryyQ8h66S24Q5emWpRgbDNl+vS/0kyBag==",
  "subCode": "",
  "subMsg": ""
}

Group Page for Unassigned Devices

Interface Description

Obtain the page of unassigned devices based on the query conditions.

Interface Method

tracker.groupDevice.pageUnAllocatedDevice

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 11
pageSizeintYesPage size, 1-50 items10
userGroupIdintYesGroup ID125
deviceCodestringNoDevice code250700097T

Return Data

NameTypeRequiredDescriptionExample
totalintYesTotal number1
rowsarray[object]YesData list
rows.userDeviceIdintYesDevice ID646
rows.deviceStatusstringYesDevice status
online: Online
offline: Offline
offline
rows.alarmFlagintYesTrip alarm mark
0: No alarm
1: Alarm
0
rows.deviceTypestringYesDevice typeTracker10
rows.deviceCodestringYesDevice code200700090T
rows.customNamestringNoUser-defined device nameFresh Tracker10
rows.tripCodestringNoWaybill numberorangeCode
rows.tripStatusstringYesTrip status
wait: Waiting to start
ing: Recording
end: Stopped
ing
rows.goodsNamestringNoCargo nameorange
rows.expectedBeginTimelongNoExpected start time1747640566191
rows.expectedEndTimelongNoExpected end time1747640588653

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.groupDevice.pageUnAllocatedDevice",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747640566191",
  "version": "1.0",
  "bizContent": {
    "pageNum": 1,
    "pageSize": 10,
    "userGroupId": 186
  },
  "sign": "j4P3eHX+Dct4lIp5LnLrKJsQI9MW+YhAzG0bP/W+ETb9bkABoXOCE+tpTGg+dgX1iJbAe1yzKlM9XWMHL3dhl7Y9MQRuMakndfB9JAgd4dUWVzhpv9Q5zK6wOIIpTjJBtxe//dZArsG3BeHKBc6lq/5KibsZ7vNRY2NqAxy9QeOmcCoChGrJ5Qqk/IWTVzpakwY9ioKKM3sDQMPxteyHP+k+FV+q7XiSCHK/3oWV2aIoFwnRhcbK2C2Y4JyK5n4Wr5Ghsy/Sgi6y5nXCdjzCyPE2dsbqMFB0H1I4K79lxKedQQzHcExsNCMEUXHaiRMI0tceU65UCAqxzhBb5WGN1Q=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "deviceType": "Tracker10",
        "customName": "Fresh Tracker10",
        "deviceCode": "200700082T",
        "userDeviceId": 716,
        "alarmFlag": "0",
        "deviceStatus": "offline",
        "tripCode": "123",
        "goodsName": "orange",
        "tripStatus": "end",
        "expectedBeginTime": 1747640566191,
        "expectedEndTime": 1747640588653
      }
    ]
  },
  "msg": "success",
  "sign": "hDRDjqSgZojnEgVgeI5h9oxFUCXtg4lryJDneGy77qSqkiGB1SoPQSBbnB91Igwlk2G2+OA9mlvNsqgYh5ad5/VRNOjMBi+xq5/TIJzrrRNqveXcyb+2JjQIRDMIb4wVumYreq6HDHnlAhWeoNdFEEdz5b6Str06tbepAyREayz8o3d0u2xc9WGqAeiRI7bzqvbf7z0lXW04yMN9zCFqcCfgEmrWqxvRqrMx180Qz/syONJH7LBh+5YNDvOXsGktG8JdcjI1uRhCzK2fh5qWIGJYL0gykfH9ukUiS42xc4TIjvAxN4FpCnXvg4z3LOcvMQLoJyqr7HgGlouHV4qMzA==",
  "subCode": "",
  "subMsg": ""
}

Remove the Device from the Group

Interface Description

Remove the device from the group.

Interface Method

tracker.groupDevice.unbindDevice

Request Parameter

NameTypeRequiredDescriptionExample
userGroupDeviceIdListarray[int]YesID list of assigned devices[635]

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success; false: Failedtrue

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.groupDevice.unbindDevice",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747645671183",
  "version": "1.0",
  "bizContent": {
    "userGroupDeviceIdList": [645],
    "userGroupId": 186
  },
  "sign": "Psbn5gxDHI2mmJEezUmL0RnEfT3ty0ui9fQNm1wLV9CJbBr8QnExZw4rETK1aCOn6jSppDEwhbhKlpYa1dNZaMdALLvonwAIgUSMCt1LC0lFx+OAVjqQJ70wCNt4cUzcltaVAisSL7TZaabBgztSjDGgKPEsVKjEWOyDDbh7wZUWApRKYudErkhuOZhu4qLXlp7ZamtzSQzA2xc3xPtDTPUD1KqgpbnEosS2CtL+NewA4eeLCP/CXntIuUUie81wYl4Llvo5Er0i+1imFxMcYQnX5sOvOKIE635zRB9BoniUaWjqysHNDhTH0pwcBbv7A1/W7KximGwEEXkEHEGyDw=="
}

Example for Returning Data

{
  "code": "0",
  "data": true,
  "msg": "success",
  "sign": "JTbz7QTYiTDKkLpCipwMmx2GK2TGM7YCVg1rtq+btve1zi/tv2qkAQ54xPmzpu3IMr0DiZ++7QT62Kpf7lmW4pePxjt9nEvM/rFy7+/OX0qKTvzoWPYup+DcMnZ1FNcseS6H6BTx83BGKp406HWBT0K1i/0v3hJTphWKnzrDAAZfgCKf5ieu2DrwGHLeRnR99Snk6ocmiE9t3fJN1u11W8+KCHQDQbL7x4NsRae6VsMP63v4lDbVtTcu2wpLOExwwzqFk4IVoJbEUU0VnyhzVoOrGzOxJpG7huoYOkyn9c740/5f7LD2Zk/8RCRPHHl29g1QmOsqk4JkKiO3M0ECIw==",
  "subCode": "",
  "subMsg": ""
}

Move the Device into the Group

Interface Description

Move the device into the group.

Interface Method

tracker.groupDevice.bindDevice

Request Parameter

NameTypeRequiredDescriptionExample
userDeviceIdListarray[int]YesDevice ID list[635]
userGroupIdintYesUser group ID186

Return Data

NameTypeRequiredDescriptionExample
databoolYestrue: Success; false: Failedtrue

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.groupDevice.bindDevice",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747642861194",
  "version": "1.0",
  "bizContent": {
    "userDeviceIdList": [635],
    "userGroupId": 186
  },
  "sign": "WYu7DvBTRuL0eWqNlKKzaQED24OmOEC5MPAnrxnoD0J7g8t9SzCUmXyZTgclReYW2qJWCESAkbW5L7qLlwwsPucb0k68WxCNwFB9FitOAalrXA6cOewBtsTmK0a8Upr0TESQYftSshQ/ZUbQLsEMTwNIPMtjiFfXrtHlaF78P/HVq0jV40mworgCAvDsLX/kXNvGZUluwn8iqw4l/mjsA7CppcFMSY/+r8SQTCQ5pCW8cGp0RNsVtdtR7x47V70Jl12g+GHbTMMebn72ejSM2VwjhV5HARK6KZfTx4ey/fJNUcHE07XAB8PvQnd9uSI1PFzixg7XUvMeOjGfUjOpqg=="
}

Example for Returning Data

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