IotHub
  1. push
IotHub
  • README
  • Update Record
  • token
    • createToken
      POST
    • destroyToken
      POST
  • customer
    • customerPage
      POST
    • customerTree
      POST
  • device
    • command
      • commandSend
      • commandInfoList
      • cutOilElectric
      • getConfig
    • devicePage
      POST
    • deviceTypes
      POST
    • deviceTypeInfo
      POST
    • deviceDataByDeviceIds
      POST
    • deviceDataByCustomerId
      POST
    • deviceTripInfoByTripId
      POST
    • deviceTripsByDeviceId
      POST
    • expandInfoByDeviceId
      POST
    • saveDeviceChannelName
      POST
  • fence
    • fencePage
      POST
    • fenceInfo
      POST
    • addFence
      POST
    • saveFence
      POST
    • delFence
      POST
    • fenceDevices
      POST
    • fenceDeviceUpdate
      POST
    • fenceDeviceDel
      POST
    • fenceDeviceAdd
      POST
  • push
    • README
  • video
    • H5 page
    • H5 Page-V2
    • liveVideo
    • playBackList
    • historicalUpload
    • playBack
    • replaySet
    • taskPage
    • taskDelete
    • getNodes
  • alarm
    • alarmTypeList
    • alarmFilePage
    • alarmFileByAlarmId
    • alarmHistoryPage
    • alarmPageByUser
  • audio
    • README
    • talk
    • talkPlus
  • gallery
    • filePageV2
    • filePage
    • deleteFile
    • capture
    • capturePage
  • fleet
    • faceRecordPage
  • gps
    • historyData
  • Protocol Analysis
    POST
  1. push

README

1.
Using a webhook, push notifications will be made when data is reported on the device.
2.
Select the service that needs to be activated for push, fill in the URL address
image.png
3.
When the device reports data, it will integrate the reported data into a parameter called "data".
4.
Different push situations result in different data objects contained in "data"

AlarmData#

FieldTypeRequiredNote
actualbooleantrueReal time or supplementary transmission
deviceIdstringtrueDevice ID
reportCtnumbertrueDevice Data reporting time (Device Time Zone)
deviceCtnumbertrueGateway Data reporting time (UTC +0)
alarmTypestringtrueAlarm types ‘,’ multiple separated by commas
alarmIdstringtrueUnique alarmId,matches the “alarmFilePage” alarmId field “alarmHistoryPage” id field
idstringtrueUnique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
latnumbertrue
lonnumbertrue

"data":"{
\"actual\":true,
\"deviceId\":\"105045133913\",
\"reportCt\":1735296575,
\"deviceCt\":1735296575,
\"alarmType\":\"laneShift\",
\"id\":\"105045133913_1843895343409950720",
\"alarmId\":\"1843895343409950720\",
\"lat\":24.067906,
\"lon\":76.96842
}"
You can query the alarm file corresponding to the alarm ID through 'alarm/alarmFileByAlarmId'.

GPS Data#

FieldTypeRequiredNote
actualbooleantrueReal time or supplementary transmission
deviceIdstringtrueDevice ID
reportCtnumbertrueDevice Data reporting time (Device Time Zone)
deviceCtnumbertrueGateway Data reporting time (UTC +0)
numintegertruenumber of satellites
lonnumberfalse
latnumberfalse
speednumberfalse
courseintegerfalseindicates the direction of travel
idstringtrueUnique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
"data":"{
\"actual\":true,
\"num\":9,
\"lon\":113.938709,
\"deviceId\":\"105045133913\",
\"speed\":0,
\"reportCt\":1724822445,
\"course\":154,
\"deviceCt\":1724793630,
\"id\":\"105045133913_1234567893043003392\",
\"lat\":22.577894
}"

DeviceInfo Data#

FieldTypeRequiredNote
actualbooleantrueReal time or supplementary transmission
deviceIdstringtrueDevice ID
reportCtnumbertrueDevice Data reporting time (Device Time Zone)
deviceCtnumbertrueGateway Data reporting time (UTC +0)
accintegerfalseAcc status 0 off/1 on
blockedStatusintegerfalseOil and electricity status 0 off/1 on
odometernumberfalseMileage Statistics
elecintegerfalsePower on status 0 off/1 on
ioStatusintegerfalseI/O status
signalintegerfalseGSM signal strength
voltagenumberfalsevoltage V,External voltage, only valid for wired devices
quantitynumberfalsePercentage of battery
idstringtrueUnique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
"data":"{
\"acc\":1,
\"actual\":true, 
\"blockedStatus\":1,
\"odometer\":7.3,
\"elec\":0,
\"deviceId\":\"105045133913\",
\"reportCt\":1724837171,
\"ioStatus\":0,
\"deviceCt\":1724808355,
\"id\":\"105045133913_1234567895482220544\",
\"signal":27
}"

PassThrough Data#

FieldTypeRequiredNote
messagestringtrueJSON string containing com1 and com2
deviceIdstringtrueDevice ID
reportCtnumbertrueDevice Data reporting time (Device Time Zone)
deviceCtnumbertrueGateway Data reporting time (UTC +0)
idstringtrueUnique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
"data": "{
\"message\": \"{
\"com1\":\"f5fffff5d7dff5f5fff5fdd5ffdffddfd5dffdff7ddddfd5ffdfd5ffdfffd5fdf7dfddd5fdf5f5ffddd5f7\",
\"com2\":\"fffddffffff5ff55f5fffd5dfff5dffff555dddfd7ffffd5ffdffdffd7dfffd5dffffffdffdfff7dddffdfd7ddddfff7dfdddfdffff5f7fdf5ffdddfddffd5d7ffdffdffdfddfdfff5fd5dfff7f5dffd\"
}\",
\"deviceId\": \"105045133913\",
\"reportCt\": 1736756976,
\"deviceCt\":1736756976,
\"id\":\"105045133913_1878721045339443200\"
}"

AlarmFile Data#

FieldTypeRequiredNote
idstringtrueUnique alarmId,match with alarmId from alarm data
deviceIdstringtrueDevice ID
fileUrlstringtrueurl
fileTypestringtruePicture 00 Audio 01 Audio and video 02 Text 03 Others 04
"data": "{
\"id\":\"1924683352005763072\",
\"deviceId\":\"105045133913\",
\"fileUrl\":\"https://files.imettax.com/mettaxftp/202505%2Fsit_video_alarm_2025051303_17471079303273973080227010339153_00_00_122549.jpg\",
\"fileType\":\"00\"
}"
5.
Sample code for receiving URL implementation
Java
NodeJS
Modified at 2025-05-22 07:28:02
Previous
fenceDeviceAdd
Next
H5 page
Built with