1.说明

当你配置好接收客户端的URL后,当系统接收到设备上报的数据后,理解将数据推送给订阅的客户端API。工作流程如下:

关于Rest API,我们可以参考:Open API的介绍
我们首先可以通过“推送规则配置”将接收客户端的API配置到系统中,配置完毕后,当系统收到设备上报的数据后会立即将设备数据通过webhook服务推送到指定的API中。
关于WebHook推送的消息体请参考下面介绍。

2.消息体说明

消息将分为5种类型进行推送,分别是:
(1)定位数据
(2)报警数据
(3)命令应答数据
(4)事件数据
(5)联网状态数据

2.1.定位数据

2.1.1.消息体示例

{
    "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.消息体说明

字段 类型 说明
terminalId String 终端唯一标识
terminalNum String 终端S/N
terminalType int 终端类型枚举值,可以通过OpenAPI查询出系统定义的所有类型:http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6etam0bago
vehicleId String 资产唯一标识
vehicleNum String 资产编码
gnssTime String 终端上报数据时间(UTC)
gnssTimestamp long 终端上报数据UNIX时间戳
recvTime String 服务器接收数据时间(UTC)
recvTimestamp long 服务器接收数据UNIX时间戳
locationType int 定位类型;0:不定位;1:GNSS定位;2:基站定位;3:定位保持;4:WIFI定位
lat double 纬度,WGS84,dd.dddddd格式
lon double 经度,WGS84,ddd.dddddd格式
speed double 速度,单位:km/h
direction int 方向值,0~360;0代表正北
mileage double 里程值,单位:km
altitude int 海拔高度,单位:m
battery int 内置电池电量百分比,只针对电池产品有效,车载系列产品无效
voltage double 内置电池电压值,单位:V,只针对电池产品有效,车载系列产品无效
acc int 车辆的ACC状态(0:ACC关;1:ACC开),只对车载定位器有效
gnssValue int 定位时,卫星颗数
gsmValue int 设备的GSM通讯质量值
alarmTypeList List<int> 报警枚举值的集合,详情可以通过OpenAPI查询系统定义的所有报警类型:http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6hisrogofk
eventTypeList List<int> 事件枚举值的集合,详情可以通过OpenAPI查询系统定义的所有事件类型:http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6hmnmhjdfh
expandMapJson string 拓展内容JSON字符串
statusMapJson string 拓展状态JSON字符串

statusMapJson 说明

字段 类型 说明
realtime_data int 0:实时数据;1:盲区数据
normal_data int 0:实时数据;1:TOW 数据
oil_circuit int 0:车辆油路正常;1:车辆油路断开
oil_electric int 0:车辆电路正常;1:车辆电路断开
door_lock int 0:车门解锁;1:车门加锁
awaken String 唤醒类型(0:周期采样 1:低电量触发 2:运动触发 3:碰撞触发 4:光照触发 5.温湿度触发 6.温度触发 7.湿度触发 8:闹钟触发;9:蓝牙连接触发;64:周期触发 65:开机触发 66:ACC点火 67:ACC熄火 68:VCC连接 69:VCC移除 70:虚拟点火(Gsensor) 71:虚拟点火(GNSSAST)72:虚拟熄火(Gsensor) 73:拐点触发 74:超速触发 75:OTA启动 76:OTA成功 77:OTA失败 78:首次定位 79:低压触发 80:低压解除;81:JAMMING触发 82:距离触发 83:碰撞触发 84:DI1触发 85:DI2触发 86:DI3触发 87:DI4触发 88:DI5触发 89:DI6触发;90:DI7触发 91:DI8触发 92:DI9触发 93:DI10触发 94:AI上限触发 95:AI下限触发 96:电池低压触发 97:电池低压解除 ;98:电池开始充电 99:电池充满 100:软复位触发 101:虚拟点火(Voltage) 102:虚拟熄火(Voltage) 103:TOW开始 104:TOW停止 105:进入电子围栏 106:离开电子围栏 107:深度休眠周期唤醒 108:DI1解除 109:急加速 110:急减速 111:急转弯 112:加速度点火)
powered int 外部供电状态(1:供电中;0:未供电)

expandMapJson 说明

字段 类型 说明
software_version String 固件版本
external_voltage double 外接电源电压,单位V
wifi List WIFI信息;mac:MAC地址,rssi:RSSI
device Object 设备信息;包含字段如下:work_model:工作模式(0:周期模式;1:触发模式;2:跟踪模式+触发模式;3:时钟模式+触发模式;4:周期模式+触发模式); imei:IMEI号;iccid:ICCID;device_type:设备类型
battery_charge int 充电状态(0无效;1未充电;2充电;3充满;4异常)
sensor List 传感器Sensor数据,sensor数据体如下
sensor数据体
字段 类型 说明
light int 光照度,单位:Lux
temperature double 温度,单位:℃
humidity double 湿度,单位:%
accelerometer String 加速度;格式:x:100;y:200;z:300
light_Limit int 光照度阈值,单位:Lux
temp_max double 高温度阈值,单位:℃
temp_min double 低温度阈值,单位:℃
hum_max double 高湿度阈值,单位:%
hum_min double 低湿度阈值,单位:%
pressure int 气压值,单位:Pa

2.2.报警数据

2.2.1.消息体示例

{
    "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.消息体示例

字段 类型 说明
terminalId String 终端唯一标识
terminalNum String 终端S/N
vehicleId String 资产唯一标识
vehicleNum String 资产编码
gnssTime String 终端上报数据时间(UTC)
gnssTimestamp long 终端上报数据UNIX时间戳
recvTime String 服务器接收数据时间(UTC)
recvTimestamp long 服务器接收数据UNIX时间戳
alarmType int 报警枚举值,详情可以通过OpenAPI查询系统定义的所有报警类型:http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6hisrogofk
alarmDesc String 报警描述,JSON字符串
lat double 纬度,WGS84,dd.dddddd格式
lon double 经度,WGS84,ddd.dddddd格式
lbsCells String 基站信息,格式:mcc,mnc,lac,ci,rssi;可以通过此值进行基站辅助定位
speed double 速度,单位:km/h
direction int 方向值,0~360;0代表正北
mileage double 里程值,单位:km
altitude int 海拔高度,单位:m

2.3.指令应答数据

2.3.1.消息体示例

{
    "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.消息体示例

字段 类型 说明
terminalId String 终端唯一标识
terminalNum String 终端S/N
dateTime string 指令应答时间(UTC)
timestamp long 指令应答UNIX时间戳
cmdType int 应答命令ID
cmdTypeStr string 应答命令ID,Hex字符串
replyMsgFlowId int 应答流水号
content string 应答的指令内容,JSON字符串

2.4.事件数据

2.4.1.消息体示例

{
    "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.消息体示例

字段 类型 说明
terminalId String 终端唯一标识
terminalNum String 终端S/N
vehicleId String 资产唯一标识
vehicleNum String 资产编码
gnssTime String 终端上报数据时间(UTC)
gnssTimestamp long 终端上报数据UNIX时间戳
recvTime String 服务器接收数据时间(UTC)
recvTimestamp long 服务器接收数据UNIX时间戳
eventType int 事件枚举值,详情可以通过OpenAPI查询系统定义的所有事件类型:http://124.223.60.234:8282/docs/la8XkOHHB3YhsRm6/la8XkOHHB3YhsRm6-1em6hmnmhjdfh
eventDesc String 事件描述,JSON字符串
lat double 纬度,WGS84,dd.dddddd格式
lon double 经度,WGS84,ddd.dddddd格式
lbsCells String 基站信息,格式:mcc,mnc,lac,ci,rssi;可以通过此值进行基站辅助定位
speed double 速度,单位:km/h
direction int 方向值,0~360;0代表正北
mileage double 里程值,单位:km
altitude int 海拔高度,单位:m

2.5.联网状态数据

2.5.1.消息体示例

{
    "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.消息体示例

字段 类型 说明
terminalId String 终端唯一标识
terminalNum String 终端S/N
vehicleId String 资产唯一标识
vehicleNum String 资产编码
status int 联网状态(0:注销网络;1:连接网络)
desc String 联网时设备的IP地址
gnssTime String 终端上报数据时间(UTC)
gnssTimestamp long 终端上报数据UNIX时间戳
recvTime String 服务器接收数据时间(UTC)
recvTimestamp long 服务器接收数据UNIX时间戳
作者:admin  创建时间:2023-10-09 09:41
最后编辑:admin  更新时间:2023-10-19 16:09