1.Instruction
After configuring the URL of the receiving client and receiving the data reported by the device, understand the API for pushing the data to the subscribed client. The workflow is as follows:
Regarding the Rest API, we can refer to：Open API
We can first configure the API of the receiving client into the system through the “Push Rule Configuration”. After configuration, when the system receives the data reported by the device, it will immediately push the device data to the specified API through the webhook service.
Please refer to the following introduction for the message body pushed by WebHook.
2.Message body description
Messages will be pushed into 5 types:
(1) Positioning data
(2) Alarm data
(3) Command response data
(4) Event data
(5) Networking status data
2.1.Positioning data
2.1.1.Message Body Example
{
"acc": 0,
"alarmTypeList": [],
"altitude": 72,
"battery": 0,
"direction": 285,
"eventTypeList": [],
"expandMapJson": "{\"external_voltage\":\"14.282\",\"bluetooth\":\"[]\",\"auxiliary\":\"{\\\"acc_duration\\\":100450,\\\"position_age\\\":1,\\\"hdop\\\":9}\",\"sensor\":\"[{\\\"data_type\\\":64}]\",\"software_version\":\"AOVX_VL300-LA_H2.0_EG915ULAABR03A02M08_V2.0.7_v10\",\"GPIO\":\"{\\\"00000000\\\":[\\\"00000001\\\"]}\"}",
"gnssTime": "2023-10-08T02:44:57Z",
"gnssTimestamp": 1696733097000,
"gnssValue": 5,
"gsmValue": 23,
"lat": 31.832926,
"locationType": 1,
"lon": 117.095418,
"mileage": 142113.0,
"recvTime": "2023-10-08T02:44:58.764430Z",
"recvTimestamp": 1696733098764,
"speed": 0.0,
"statusMapJson": "{\"realtime_data\":0,\"powered\":1,\"oil_electric\":0,\"normal_data\":0,\"awaken\":64,\"door3\":0,\"door2\":0,\"door5\":0,\"operate\":0,\"door4\":0,\"load\":0,\"door1\":0,\"door_lock\":0,\"oil_circuit\":0,\"confidential\":0}",
"terminalId": "C9019BFCFE5A4CF094107ED6D4ED552E",
"terminalNum": "413050517977",
"terminalType": 100,
"vehicleId": "14636AF3C6EB466D9EEFAAE6F78B3261",
"vehicleNum": "V-7977",
"voltage": 0.0
}
2.1.2.Message body description
| Field |
Type |
Description |
| terminalId |
String |
Device Unique Identification |
| terminalNum |
String |
Device S/N |
| terminalType |
int |
Enumerated values for device types, which can be used to query all system defined types through OpenAPI：http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6etam0bago |
| vehicleId |
String |
Unique identification of asset |
| vehicleNum |
String |
Asset Number |
| gnssTime |
String |
Device reporting data time（UTC） |
| gnssTimestamp |
long |
Device reporting data UNIX timestamp |
| recvTime |
String |
Server receiving data time（UTC） |
| recvTimestamp |
long |
Server receives data with UNIX timestamp |
| locationType |
int |
Positioning type; 0: Not positioned; 1: GNSS; 2: Base station positioning; 3: Positioning maintenance; 4: WIFI |
| lat |
double |
latitude，WGS84，Format: dd.dddddd |
| lon |
double |
longitude，WGS84，Format: ddd.dddddd |
| speed |
double |
Speed, unit：km/h |
| direction |
int |
Direction，0~360；0 is North |
| mileage |
double |
Mileage，unit：km |
| altitude |
int |
Altitude，unit：m |
| battery |
int |
Built-in battery power percentage, only valid for battery products, invalid for car series products |
| voltage |
double |
Built-in battery voltage value, unit: V, valid only for battery products, invalid for car series products |
| acc |
int |
The ACC status of the vehicle (0: ACC off; 1: ACC on) is only valid for on-board locators |
| gnssValue |
int |
Number of satellites during positioning |
| gsmValue |
int |
GSM communication quality value of the device |
| alarmTypeList |
List<int> |
A collection of alarm enumeration values, details can be queried through OpenAPI for all alarm types defined by the system：http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm7/la8XkOHHB3YhsRm7-1em8gmsh6fggu |
| eventTypeList |
List<int> |
A collection of event enumeration values, details can be queried through OpenAPI for all event types defined by the system：http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm7/la8XkOHHB3YhsRm7-1em8gnc6k42h9 |
| expandMapJson |
string |
Expand Content JSON String |
| statusMapJson |
string |
Extension Status JSON String |
2.2.Alarm data
2.2.1.Message Body Example
{
"alarmType": 1,
"alarmDesc":"",
"altitude": 72,
"direction": 285,
"gnssTime": "2023-10-08T02:44:57Z",
"gnssTimestamp": 1696733097000,
"gnssValue": 5,
"gsmValue": 23,
"lat": 31.832926,
"lon": 117.095418,
"lbsCells":"",
"mileage": 142113.0,
"recvTime": "2023-10-08T02:44:58.764430Z",
"recvTimestamp": 1696733098764,
"speed": 0.0,
"terminalId": "C9019BFCFE5A4CF094107ED6D4ED552E",
"terminalNum": "413050517977",
"vehicleId": "14636AF3C6EB466D9EEFAAE6F78B3261",
"vehicleNum": "V-7977",
}
2.2.2.Message body description
| Field |
Type |
Description |
| terminalId |
String |
Device Unique Identification |
| terminalNum |
String |
Device S/N |
| vehicleId |
String |
Unique identification of asset |
| vehicleNum |
String |
Asset Number |
| gnssTime |
String |
Device reporting data time（UTC） |
| gnssTimestamp |
long |
Device reporting data UNIX timestamp |
| recvTime |
String |
Server receiving data time（UTC） |
| recvTimestamp |
long |
Server receives data with UNIX timestamp |
| alarmType |
int |
Alarm enumeration value，details can be queried through OpenAPI for all alarm types defined by the system：http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm7/la8XkOHHB3YhsRm7-1em8gmsh6fggu |
| alarmDesc |
String |
Alarm description, JSON string |
| lat |
double |
latitude，WGS84，Format: dd.dddddd |
| lon |
double |
longitude，WGS84，Format: ddd.dddddd |
| lbsCells |
String |
Base station information, format: mcc, mnc, lac, ci, rssi; This value can be used for base station auxiliary positioning |
| speed |
double |
Speed, unit：km/h |
| direction |
int |
Direction，0~360；0 is North |
| mileage |
double |
Mileage，unit：km |
| altitude |
int |
Altitude，unit：m |
2.3.Command response data
2.3.1.Message Body Example
{
"cmdType": 260,
"cmdTypeStr": "0x0104",
"content": "{\"itemCount\":1,\"itemMap\":{\"0x0080\":10000},\"replyMsgFlowId\":1818}",
"dateTime": "2023-10-08T10:29:30.381108Z",
"replyMsgFlowId": 1818,
"terminalId": "C9019BFCFE5A4CF094107ED6D4ED552E",
"terminalNum": "413050517977",
"timestamp": 1696760970381
}
2.3.2.Message body description
| Field |
Type |
Description |
| terminalId |
String |
Device Unique Identification |
| terminalNum |
String |
Device S/N |
| dateTime |
string |
Command response time（UTC） |
| timestamp |
long |
Command response UNIX timestamp |
| cmdType |
int |
response message ID |
| cmdTypeStr |
string |
response message ID，Hex String |
| replyMsgFlowId |
int |
Response serial number |
| content |
string |
The content of the response, JSON string |
2.4.Event data
2.4.1.Message Body Example
{
"eventType": 6,
"eventDesc":"",
"altitude": 72,
"direction": 285,
"gnssTime": "2023-10-08T02:44:57Z",
"gnssTimestamp": 1696733097000,
"gnssValue": 5,
"gsmValue": 23,
"lat": 31.832926,
"lon": 117.095418,
"lbsCells":"",
"mileage": 142113.0,
"recvTime": "2023-10-08T02:44:58.764430Z",
"recvTimestamp": 1696733098764,
"speed": 0.0,
"terminalId": "C9019BFCFE5A4CF094107ED6D4ED552E",
"terminalNum": "413050517977",
"vehicleId": "14636AF3C6EB466D9EEFAAE6F78B3261",
"vehicleNum": "V-7977",
}
2.4.2.Message body description
| Field |
Type |
Description |
| terminalId |
String |
Device Unique Identification |
| terminalNum |
String |
Device S/N |
| vehicleId |
String |
Unique identification of asset |
| vehicleNum |
String |
Asset Number |
| gnssTime |
String |
Device reporting data time（UTC） |
| gnssTimestamp |
long |
Device reporting data UNIX timestamp |
| recvTime |
String |
Server receiving data time（UTC） |
| recvTimestamp |
long |
Server receives data with UNIX timestamp |
| eventType |
int |
Event enumeration value，details can be queried through OpenAPI for all event types defined by the system：http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm7/la8XkOHHB3YhsRm7-1em8gnc6k42h9 |
| eventDesc |
String |
Event description, JSON string |
| lat |
double |
latitude，WGS84，Format: dd.dddddd |
| lon |
double |
longitude，WGS84，Format: ddd.dddddd |
| lbsCells |
String |
Base station information, format: mcc, mnc, lac, ci, rssi; This value can be used for base station auxiliary positioning |
| speed |
double |
Speed, unit：km/h |
| direction |
int |
Direction，0~360；0 is North |
| mileage |
double |
Mileage，unit：km |
| altitude |
int |
Altitude，unit：m |
2.5.Networking status data
2.5.1.Message Body Example
{
"desc": "111.55.136.119:7834",
"gnssTime": "2023-10-08T12:14:41.126399Z",
"gnssTimestamp": 1696767281126,
"recvTime": "2023-10-08T12:14:41.126399Z",
"recvTimestamp": 1696767281126,
"status": 1,
"terminalId": "C0EBA04F40394ACCB794B2A8868C5CB5",
"terminalNum": "413052884516",
"vehicleId": "BBA7AC733F824A919ECB0BB51D3AE6DA",
"vehicleNum": "V-4516"
}
2.5.2.Message body description
| Field |
Type |
Description |
| terminalId |
String |
Device Unique Identification |
| terminalNum |
String |
Device S/N |
| vehicleId |
String |
Unique identification of asset |
| vehicleNum |
String |
Asset Number |
| status |
int |
Networking status (0: logging off the network; 1: connecting to the network) |
| desc |
String |
The IP address of the device when connected to the network |
| gnssTime |
String |
Device reporting data time（UTC） |
| gnssTimestamp |
long |
Device reporting data UNIX timestamp |
| recvTime |
String |
Server receiving data time（UTC） |
| recvTimestamp |
long |
Server receives data with UNIX timestamp |
作者：admin 创建时间：2023-10-09 11:49
最后编辑：admin 更新时间：2023-10-12 17:21
