README

Using a webhook, push notifications will be made when data is reported on the device.

Select the service that needs to be activated for push, fill in the URL address

When the device reports data, it will integrate the reported data into a parameter called "data".

Different push situations result in different data objects contained in "data"

AlarmData

Field	Type	Required	Note
actual	boolean	true	Real time or supplementary transmission
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
alarmType	string	true	Alarm types ‘,’ multiple separated by commas
alarmId	string	true	Unique alarmId,matches the “alarmFilePage” alarmId field “alarmHistoryPage” id field
id	string	true	Unique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
lat	number	true
lon	number	true
speed	number	false	km/h
alarmAttribute	string	false	Storage anomaly alarm, with storage ID. Camera loss alarm, with camera serial number. Fence entry and exit alarm, with fence name


"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

Field	Type	Required	Note
actual	boolean	true	Real time or supplementary transmission
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
num	integer	true	number of satellites
lon	number	false
lat	number	false
speed	number	false
course	integer	false	indicates the direction of travel
id	string	true	Unique 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

Field	Type	Required	Note
actual	boolean	true	Real time or supplementary transmission
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
acc	integer	false	Acc status 0 off/1 on
blockedStatus	integer	false	Oil and electricity status 0 off/1 on
odometer	number	false	Mileage Statistics
elec	integer	false	Power on status 0 off/1 on
ioStatus	integer	false	I/O status
signal	integer	false	GSM signal strength
voltage	number	false	voltage V,External voltage, only valid for wired devices
quantity	number	false	Percentage of battery
accUpdateTime	number	false	Last ACC status change time (Device Time Zone)
localizationFailure	boolean	false	The device is not positioned, and if it is true, it means it is not located
id	string	true	Unique 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

Field	Type	Required	Note
message	string	true	JSON string containing `com1` and `com2`
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
id	string	true	Unique 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

Field	Type	Required	Note
id	string	true	Unique alarmId,match with alarmId from alarm data
deviceId	string	true	Device ID
fileUrl	string	true	url
fileType	string	true	Picture 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\"
}"

Device SensorData

Field	Type	Required	Note
id	string	true	unique alarmId
deviceId	string	true	Device ID
reportCt	Long	true	Device Data reporting time (Device Time Zone)
deviceCt	Long	true	Gateway Data reporting time (UTC +0)
adc	string	true	adc simulated data

"data": "{
\"id\":\"1924683352005763072\",
\"deviceId\":\"105045133913\",
\"reportCt\":1736756976,
\"deviceCt\":1736756976,
\"adc\":\"00\"
}"

CaptureFile Data

When the capture API is called, captureId will be returned. When the capture file is uploaded, the webhook will push this message to push the captured image information.

Field	Type	Required	Note
captureId	string	true	unique alarmId
deviceId	string	true	Device ID
channelId	number	true	Device channel id
fileUrl	string	true	Capture file address

"data": "{"captureId":"1009759838","deviceId":"240070466666","channelId":1,"fileUrl":"https://xxx.com/**/video_capture_2025101707_1791444020-240070466666_1.jpg"}"

Face Check

It is important to note that the first and second messages are in no particular order, and the second message may be
faster than the first message, and you need to match it according to the id.

When the message type is 1, the data format pushed by the web hook is as follows:

Field	Type	Required	Note
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
licensePlate	string	false	License plate number
faceId	string	false	the driver s face id
driverName	string	false	Driver name
lat	number	true	Latitude
lon	number	true	Longitude
compaResult	integer	true	0: Matching successful; 1: Matching failed; 2: Timeout; 3: The function is not enabled;4: Abnormal connection; 5: No driver picture 6: The terminal face library is empty
similarity	number	true	Percentage; Range: 0.00% - 100.00% in units is 0.01%
messageType	String	true	Message type 1For face comparison result messages, 2 is driver picture messages
id	string	true	Unique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package

"data": "{
  "id": "333777444585_198669678696111100",
  "deviceId": "333777444585",
  "faceId": "15",
  "lat": "35.926264",
  "lon": "113.882785",
  "compaResult": "0",
  "similarity": 7577,
  "reportCt": 1762529189,
  "deviceCt": 1762500399,
  "licensePlate": "333777444585",
  "driverName": "zoeya11",
  "messageType": "1"
}"

When the message type is 2, the data format pushed by the web hook is as follows:

Field	Type	Required	Note
deviceId	string	true	Device ID
id	string	true	Unique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package
imageUrl	string	false	Driver image URL
status	integer	true	0: Failure 1: Success;
messageType	String	true	Message type 1For face comparison result messages, 2 is driver picture messages

"data":"{
  "id": "333777444585_198669678696111100",
  "deviceId": "333777444585",
  "imageUrl": "https://example.com/driver_image.jpg",
  "status": "1",
  "messageType": "2"
}"

Push RFID

When the device has an RFID reader and reads the RFID card, the web hook will push the following data:

Field	Type	Required	Note
deviceId	string	true	Device ID
reportCt	number	true	Device Data reporting time (Device Time Zone)
deviceCt	number	true	Gateway Data reporting time (UTC +0)
licensePlate	string	false	License plate number
rfidNo	string	false	the driver s rfidNo id
driverName	string	false	Driver name
lat	number	true	Latitude
lon	number	true	Longitude
status	integer	true	Status 1: enter 2: exit
id	string	true	Unique ID, if it matches the ID in GPS, it indicates that the information attached to this GPS package

"data":"{
"id": "333845765947_1988448015257571328",
"deviceId": "333845765947",
"lat": "32.353134",
"lon": "121.357231",
"rfidNo": "7C3F88A9",
"status": 1,
"deviceCt": 1762917925,
"reportCt": 1762917925,
"licensePlate": "845765947",
"driverName": "zoeya11"
}"

Sample code for receiving URL implementation

Java

NodeJS

AlarmData#

GPS Data#

DeviceInfo Data#

PassThrough Data#

AlarmFile Data#

Device SensorData#

CaptureFile Data#

Face Check#

Push RFID#