# 应用侧对接 #### 属性上报 以下消息转换为IoTDA平台的属性，应用可以通过查询设备影子或者数据转发接收属性上报消息。 上报位置信息 对应的消息ID：0x0200 推送样例： ``` { "resource": "device.property", "event": "report", "event_time": "20151212T121212Z", "notify_data": { "header": { "device_id": "00000000000012345678", "product_id": "ABC123456789", "app_id": "d4922d8a-6c8e-4396-852c-164aefa6638f", "gateway_id": "00000000000012345678", "node_id": "00000000000012345678", "tags": [ { "tag_value": "testTagValue", "tag_key": "testTagName" } ] }, "body": { "services": [ { "service_id": "Location", "properties": { "alarm": { "emergencyAlarm": 0, "overSpeedAlarm": 0, "fatigueDrivingAlarm": 0, "dangerousDrivingAlarm": 0, "powerVoltageAlarm": 0, "powerOffAlarm": 0, "cameraErrorAlarm": 0, "overSpeedWarning": 0, "fatigueDrivingWarning": 0, "violationDrivingAlarm": 0, "tirePressureWarning": 0, "rightTurnErrorAlarm": 0, "overDrivingTimeAlarm": 0, "overParkAlarm": 0, "drivingAreaAlarm": 0, "drivingRouteAlarm": 0, "drivingTimeAbnormalAlarm": 0, "offCourseAlarm": 0, "gasolineAlarm": 0, "stolenAlarm": 0, "startingAbnormalAlarm": 0, "displacementAbnormalAlarm": 0, "rolloverAlarm": 0, "rolloverWarning": 0, "icerrorAlarm": 0, "lcderrorAlarm": 0, "ttserrorAlarm": 1, "gnssantennaShortCircuitAlarm": 0, "gnsserrorAlarm": 0, "gnssantennaNotConnectedAlarm": 0, "vssalarm": 0 }, "status": { "accStatus": 0, "positioningStatus": 0, "latitudeStatus": 0, "longitudeStatus": 0, "businessStatus": 0, "encryptedStatus": 0, "forwardCollisionWarningStatus": 0, "laneDeviationAlarmStatus": 0, "loadStatus": 0, "oilStatus": 0, "powerStatus": 1, "doorStatus": 0, "firstDoorStatus": 0, "secondDoorStatus": 0, "thirdDoorStatus": 0, "fourthDoorStatus": 0, "fifthDoorStatus": 0, "galileoStatus": 0, "vehicleStatus": 0, "gpsstatus": 0, "glonassstatus": 0, "bdsstatus": 0 }, "longitude": 116.307629, "latitude": 40.058359, "height": 312, "speed": 3, "direction": 99, "dateTime": "200707192359", "extend": [ ] }, "event_time": "20151212T121212Z" } ] } } } ``` 表1协议报文字段与属性对应表 | 起始字节 | 字段 | 数据类型 | 对应属性 | |:---|:---|:---|:---| | 0 | 报警标志 | DWORD | alarm | | 4 | 状态 | DWORD | status | | 8 | 纬度 | DWORD | latitude | | 12 | 经度 | DWORD | longitude | | 16 | 高程 | WORD | height | | 18 | 速度 | WORD | speed | | 20 | 方向 | WORD | direction | | 21 | 时间 | BCD\[6\] | dateTime | 表2报警预警标志位与alarm属性对应表 | 位 | 定义 | 对应属性 | |:---|:---|:---| | 0 | 1：紧急报警 | emergencyAlarm | | 1 | 1：超速报警 | overSpeedAlarm | | 2 | 1：疲劳驾驶报警 | fatigueDrivingAlarm | | 3 | 1：危险驾驶行为报警 | dangerousDrivingAlarm | | 4 | 1：GNSS模块发生故障报警 | gnsserrorAlarm | | 5 | 1：GNSS天线未接或被剪断报警 | gnssantennaNotConnectedAlarm | | 6 | 1：GNSS天线短路报警 | gnssantennaShortCircuitAlarm | | 7 | 1：终端主电源欠压报警 | powerVoltageAlarm | | 8 | 1：终端主电源掉电报警 | powerOffAlarm | | 9 | 1：终端LCD或显示器故障报警 | lcderrorAlarm | | 10 | 1：TTS模块故障报警 | ttserrorAlarm | | 11 | 1：摄像头故障报警 | cameraErrorAlarm | | 12 | 1：道路运输证IC卡模块故障报警 | icerrorAlarm | | 13 | 1：超速预警 | overSpeedWarning | | 14 | 1：疲劳驾驶预警 | fatigueDrivingWarning | | 15 | 1：违规行驶报警 | violationDrivingAlarm | | 16 | 1：胎压预警 | tirePressureWarning | | 17 | 1：右转盲区异常报警 | rightTurnErrorAlarm | | 18 | 1：当天累计驾驶超时报警 | overDrivingTimeAlarm | | 19 | 1：超时停车报警 | overParkAlarm | | 20 | 1：进出区域报警 | drivingAreaAlarm | | 21 | 1：进出路线报警 | drivingRouteAlarm | | 22 | 1：路段行驶时间不足/过长报警 | drivingTimeAbnormalAlarm | | 23 | 1：路线偏离报警 | offCourseAlarm | | 24 | 1：车辆VSS故障 | vssalarm | | 25 | 1：车辆油量异常报警 | gasolineAlarm | | 26 | 1：车辆被盗报警（通过车辆防盗器） | stolenAlarm | | 27 | 1：车辆非法点火报警 | startingAbnormalAlarm | | 28 | 1：车辆非法位移报警 | displacementAbnormalAlarm | | 29 | 1：碰撞侧翻报警 | rolloverAlarm | | 30 | 1：侧翻预警 | rolloverWarning | | 31 | 保留 | - | 表3状态标志位与status属性对应表 | 位 | 定义 | 对应属性 | |:---|:---|:---| | 0 | 0：ACC关；1：ACC开 | accStatus | | 1 | 0：未定位；1：定位 | positioningStatus | | 2 | 0：北纬；1：南纬 | latitudeStatus | | 3 | 0：东经；1：西经 | longitudeStatus | | 4 | 0：运营状态；1：停运状态 | businessStatus | | 5 | 0：经纬度未经保密插件加密；1：经纬度已经保密插加密 | encryptedStatus | | 6 | 1：紧急刹车系统采集的前撞预警 | forwardCollisionWarningStatus | | 7 | 1：车道偏移预警 | laneDeviationAlarmStatus | | 8\~9 | 00：空车；01：半载；10：保留；11：满载 | loadStatus | | 10 | 0：车辆油路正常；1：车辆油路断开 | oilStatus | | 11 | 0：车辆电路正常；1：车辆电路断开 | powerStatus | | 12 | 0：车门解锁；1：车门加锁 | doorStatus | | 13 | 0：门1关；1：门1开（前门） | firstDoorStatus | | 14 | 0：门2关；1：门2开（中门） | secondDoorStatus | | 15 | 0：门3关；1：门3开（后门） | thirdDoorStatus | | 16 | 0：门4关；1：门4开（驾驶席门） | fourthDoorStatus | | 17 | 0：门5关；1：门5开（自定义） | fifthDoorStatus | | 18 | 0：未使用GPS卫星进行定位；1：使用GPS卫星进行定位 | gpsstatus | | 19 | 0：未使用北斗卫星进行定位；1：使用北斗卫星进行定位 | bdsstatus | | 20 | 0：未使用GLONASS卫星进行定位；1：使用GLONASS卫星进行定位 | glonassstatus | | 21 | 0：未使用Galileo卫星进行定位；1：使用Galileo卫星进行定位 | galileoStatus | | 22 | 0：车辆处于停止状态；1：车辆处于行驶状态 | vehicleStatus | | 23\~31 | 保留 | - | #### 同步命令 以下消息类型，应用可以通过下发同步命令的方式，给终端设备发送消息，参考[下发同步命令](https://support.huaweicloud.com/api-iothub/iot_06_v5_0038.html)。 ![](https://support.huaweicloud.com/usermanual-iothub/public_sys-resources/caution_3.0-zh-cn.png) 请使用API接口做业务调测，部分命令目前不能通过界面下发。 #### 终端管理-设置终端参数 接口说明 请求对应的消息ID：0x8103 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "TerminalManagement", "command_name": "SetTerminalParameters", "paras": { "parameters": { "1": 120 } } } ``` 请求参数 paras字段定义 表4参数描述 | 字段名 | 必选/可选 | 类型 | 参数描述 | |:---|:---|:---|:---| | parameters | 必选 | JsonObject | **参数说明：**设置的终端参数的参数列表，其中key为参数ID（十进制表示），value为参数值。 **取值约束：** - 平台当前固定心跳时长为180s - 不支持多值参数 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表5参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号。 | | msgId | int | **参数说明：**对应的平台的消息ID。 | | resultCode | int | **参数说明：**结果。 | #### 终端管理-查询终端参数 接口说明 请求对应的消息ID：0x8104 响应对应的消息ID：0x0104 请求示例 ``` { "service_id": "TerminalManagement", "command_name": "QueryTerminalParameters", "paras": {} } ``` 响应示例 ``` { "command_id": "1641973633890258246", "response": { "paras": { "flowNo": 0, "total": 1, "parameters": { "1": 120 } }, "result_code": 0 } } ``` 响应参数 paras字段定义 表6参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号。 | | total | int | **参数说明：**应答参数个数。 | | parameters | JsonObject | **参数说明：**终端参数的参数列表，其中key为参数ID（十进制表示），value为参数值。 | #### 终端管理-查询指定终端参数 接口说明 请求对应的消息ID：0x8106 响应对应的消息ID：0x0104 请求示例 ``` { "service_id": "TerminalManagement", "command_name": "QueryAssignedTerminalParameters", "paras": { "parameterIds": [1] } } ``` 请求参数 paras字段定义 表7参数描述 | 字段名 | 必选/可选 | 类型 | 参数描述 | |:---|:---|:---|:---| | parameterIds | 必选 | stringList | **参数说明：**查询的终端参数的参数ID（十进制表示）列表。 | 响应示例 ``` { "command_id": "1641973633890258246", "response": { "paras": { "flowNo": 0, "total": 1, "parameters": { "1": 120 } }, "result_code": 0 } } ``` 响应参数 paras字段定义 表8参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号。 | | total | int | **参数说明：**应答参数个数。 | | parameters | JsonObject | **参数说明：**终端参数的参数列表，其中key为参数ID（十进制表示），value为参数值。 | #### 终端管理-终端控制 接口说明 请求对应的消息ID：0x8105 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "TerminalManagement", "command_name": "TerminalControl", "paras": { "commandId": 4, "parameter": null } } ``` 请求参数 paras字段定义 表9参数描述 | 字段名 | 必选/可选 | 类型 | 参数描述 | |:---|:---|:---|:---| | commandId | 必选 | int | **参数说明：**命令字（十进制表示） | | parameter | 可选 | string | **参数说明：**命令参数 | 响应示例 ``` { "command_id": "1641970324270870620", "response": { "paras": { "flowNo": 0, "msgId": 33029, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表10参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 终端管理-查询终端属性 接口说明 请求对应的消息ID：0x8107 响应对应的消息ID：0x0107 请求示例 ``` { "service_id": "TerminalManagement", "command_name": "QueryTerminalProperty", "paras": {} } ``` 响应示例 ``` { "command_id": "1641970411683486238", "response": { "paras": { "clientType": { "passenger": true, "dangerousGoods": true, "track": true, "taxis": true, "video": true, "splitter": false, "trailer": false }, "manufacturerId": "2D_AN", "deviceType": "BSJ-GF-06", "nodeId": "5kw3noL", "iccId": "12345678901234567890", "hardwareVersion": "3.0.0", "firmwareVersion": "1.1.25", "gssn": { "galileo": true, "gps": true, "bds": true, "glonass": true }, "communication": { "other": false, "gprs": true, "cdma": true, "tdscdma": true, "wcdma": true, "cdma2000": true, "tdlte": true } }, "result_code": 0 } } ``` 响应参数 paras字段定义 表11参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | clientType | JsonObject | **参数说明：**终端类型。 - passenger：false-不适用客运车辆，true-适用客运车辆 - dangerousGoods：false-不适用危险品车辆，true-适用危险品车辆 - track：false-不适用普通货运车辆，true-适用普通货运车辆 - taxis：false-不适用出租车辆，true-适用出租车辆 - video：false-不支持硬盘录像，true-支持硬盘录像 - splitter：false-一体机，true-分体机 - trailer：false-不适用挂车，true-适用挂车 | | manufacturerId | string | **参数说明：**制造商ID | | deviceType | string | **参数说明：**终端型号 | | nodeId | string | **参数说明：**终端ID | | iccId | string | **参数说明：**终端SIM卡ICCID | | hardwareVersion | string | **参数说明：**终端硬件版本号 | | firmwareVersion | string | **参数说明：**终端固件版本号 | | gssn | jsonObject | **参数说明：**GNSS模块属性 - galileo：false-不支持Galileo定位，true-支持Galileo定位 - gps：false-不支持GPS定位，true-支持GPS定位 - bds：false-不支持北斗定位，true-支持北斗定位 - glonass：false-不支持GLONASS定位，true-支持GLONASS定位 | | communication | jsonObject | **参数说明：**通信模块属性 - other：false-不支持其他通信方式，true-支持其他通信方式 - gprs：false-不支持GPRS通信方式，true-支持GPRS通信方式 - cdma：false-不支持CDMA通信方式，true-支持CDMA通信方式 - tdscdma：false-不支持TD-SCDMA通信方式，true-支持TD-SCDMA通信方式 - wcdma：false-不支持WCDMA通信方式，true-支持WCDMA通信方式 - cdma2000：false-不支持CDMA2000通信方式，true-支持CDMA2000通信方式 - tdlte：false-不支持TD-LTE通信方式，true-支持TD-LTE通信方式 | #### 位置及报警-位置信息查询 接口说明 请求对应的消息ID：0x8201 响应对应的消息ID：0x0201 请求示例 ``` { "service_id": "Location", "command_name": "QueryLocation", "paras": {} } ``` 响应示例 ``` { "command_id": "1641971430850245415", "response": { "paras": { "flowNo": 0, "locationReport": { "alarm": { "emergencyAlarm": 0, "overSpeedAlarm": 1, "fatigueDrivingAlarm": 0, "dangerousDrivingAlarm": 1, "powerVoltageAlarm": 0, "powerOffAlarm": 0, "cameraErrorAlarm": 1, "overSpeedWarning": 1, "fatigueDrivingWarning": 0, "violationDrivingAlarm": 0, "tirePressureWarning": 0, "rightTurnErrorAlarm": 0, "overDrivingTimeAlarm": 0, "overParkAlarm": 0, "drivingAreaAlarm": 0, "drivingRouteAlarm": 0, "drivingTimeAbnormalAlarm": 0, "offCourseAlarm": 0, "gasolineAlarm": 0, "stolenAlarm": 0, "startingAbnormalAlarm": 0, "displacementAbnormalAlarm": 0, "rolloverAlarm": 0, "rolloverWarning": 0, "gnsserrorAlarm": 1, "gnssantennaNotConnectedAlarm": 0, "lcderrorAlarm": 1, "ttserrorAlarm": 0, "icerrorAlarm": 0, "vssalarm": 0, "gnssantennaShortCircuitAlarm": 1 }, "status": { "accStatus": 0, "positioningStatus": 0, "latitudeStatus": 0, "longitudeStatus": 1, "businessStatus": 0, "encryptedStatus": 1, "forwardCollisionWarningStatus": 0, "laneDeviationAlarmStatus": 0, "loadStatus": 0, "oilStatus": 1, "powerStatus": 0, "doorStatus": 1, "firstDoorStatus": 1, "secondDoorStatus": 1, "thirdDoorStatus": 0, "fourthDoorStatus": 0, "fifthDoorStatus": 0, "galileoStatus": 0, "vehicleStatus": 0, "gpsstatus": 0, "bdsstatus": 0, "glonassstatus": 0 }, "longitude": 0.041957, "latitude": 0.056143, "height": 48243, "speed": 10001, "direction": 300, "dateTime": "220112151406", "extend": [] } }, "result_code": 0 } } ``` 响应参数 表12参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | locationReport | jsonObject | **参数说明：** 字段定义参考[表13] | 表13协议报文字段与属性对应表 | 起始字节 | 字段 | 数据类型 | 对应属性 | |:---|:---|:---|:---| | 0 | 报警标志 | DWORD | alarm | | 4 | 状态 | DWORD | status | | 8 | 纬度 | DWORD | latitude | | 12 | 经度 | DWORD | longitude | | 16 | 高程 | WORD | height | | 18 | 速度 | WORD | speed | | 20 | 方向 | WORD | direction | | 21 | 时间 | BCD\[6\] | dateTime | #### 位置及报警-临时位置跟踪控制 接口说明 请求对应的消息ID：0x8202 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "Location", "command_name": "LocationTrace", "paras": { "timeInterval": 10, "period": 20 } } ``` 请求参数 paras字段定义 表14参数描述 | 字段名 | 必选/可选 | 类型 | 参数描述 | |:---|:---|:---|:---| | timeInterval | 必选 | int | **参数说明：**时间间隔，单位为秒（s） | | period | 必选 | int | **参数说明：**位置跟踪有效期，单位为秒（s） | 响应示例 ``` { "command_id": "1641971752394383473", "response": { "paras": { "flowNo": 0, "msgId": 33282, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数 paras字段定义 表15参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 位置及报警-人工确认报警信息 接口说明 对应的消息ID：0x8203 请求示例 ``` { "service_id": "Location", "command_name": "AlarmConform", "paras": { "flowNo": 123, "criticalAlarm": false, "dangerousWarning": false, "areaAlarm": true, "routeAlarm": false, "drivingTimeAlarm": false, "startingAbnormalAlarm": false, "displacementAbnormalAlarm": false } } ``` 请求参数 paras字段定义 表16参数描述 | 字段名 | 必选/可选 | 类型 | 参数描述 | |:---|:---|:---|:---| | flowNo | 必选 | int | **参数说明：**报警消息流水号 | | criticalAlarm | 必选 | boolean | **参数说明：**确认紧急报警 | | dangerousWarning | 必选 | boolean | **参数说明：**确认危险预警 | | areaAlarm | 必选 | boolean | **参数说明：**确认进出区域报警 | | routeAlarm | 必选 | boolean | **参数说明：**确认进出路线报警 | | drivingTimeAlarm | 必选 | boolean | **参数说明：**确认路段行驶时间不足/过长报警 | | startingAbnormalAlarm | 必选 | boolean | **参数说明：**确认车辆非法点火报警 | | displacementAbnormalAlarm | 必选 | boolean | **参数说明：**确认车辆非法位移报警 | 响应示例 ``` { "command_id": "1641971845905632317", "response": { "paras": { "flowNo": 0, "msgId": 33283, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数 paras字段定义 表17参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 位置及报警-链路检测 接口说明 请求对应的消息ID：0x8204 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "Location", "command_name": "CheckConnection", "paras": {} } ``` 响应示例 ``` { "command_id": "1641971911322353065", "response": { "paras": { "flowNo": 0, "msgId": 33284, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数 paras字段定义 表18参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 车辆管理-设置圆形区域电子围栏 接口说明 请求对应的消息ID：0x8600 响应对应的消息ID：0x0001（终端通用响应） ``` { "service_id": "VehicleManagement", "command_name": "SetRoundArea", "paras": { "type": 1, "areas": [{ "areaId": 1, "areaProperty": 1, "latitude": 0, "longitude": 0, "radius": 0, "startTime": "211119170110", "endTime": "211119170111", "maxSpeed": 0, "durationOverSpeed": 0, "maxNightSpeed": 0, "areaName": "test" }] } } ``` 请求参数 paras字段同协议中消息的映射关系 表19参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | type | int | 设置属性 | 0：更新区域 1：追加区域 2：修改区域 | | areas | jsonObject | 区域 | **参数说明：**圆形区域列表 | Area字段说明 表20参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | areaId | int | 区域ID | **参数说明：**区域ID | | areaProperty | int | 区域属性 | **参数说明：**区域属性 | | latitude | int | 中心点纬度 | **参数说明：**以度为单位的纬度值乘以10的6次方，精确到百万分之一。 | | longitude | int | 中心点经度 | **参数说明：**以度为单位的经度值乘以10的6次方，精确到百万分之一。 | | radius | int | 半径 | **参数说明：**单位为米 | | startTime | string | 起始时间 | **参数说明：**格式为YYMMDDHHMMSS | | endTime | string | 结束时间 | **参数说明：**格式为YYMMDDHHMMSS | | maxSpeed | int | 最高速度 | **参数说明：**单位为千米每小时（km/h） | | durationOverSpeed | int | 超速持续时间 | **参数说明：**单位为秒（s） | | maxNightSpeed | int | 夜间最高速度 | **参数说明：**单位为千米每小时（km/h） | | areaName | string | 区域名称 | **参数说明：**区域的名称描述 | 区域属性说明 表21属性说明 | 位 | 标志 | |:---|:---| | 0 | 是否开启起始时间与结束时间的判断规则，0:否；1:是 | | 1 | 是否启用最高速度，超速持续时间和夜将最高速度的判断规则，0：否；1：是 | | 2 | 进区域是否报警给驾驶员，0：否；1：是 | | 3 | 进区域是否报警给平台，0：否；1：是 | | 4 | 出区域是否告警给驾驶员，0：否；1：是 | | 5 | 出区域是否告警给平台，0：否；1：是 | | 6 | 0：北纬；1：南纬 | | 7 | 0：东经；1：西经 | | 8 | 0：允许开门；1：禁止开门 | | 9-13 | 保留 | | 14 | 0：进区域开启通信模块；1：进区域关闭通信模块 | | 15 | 0：进区域不采集GNSS详细定位数据；1：进区域采集GNSS详细定位数据 | 响应示例 ``` { "command_id": "1641971911322353065", "response": { "paras": { "flowNo": 0, "msgId": 33284, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表22参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 车辆管理-删除圆形区域电子围栏 接口说明 请求对应的消息ID：0x8601 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "VehicleManagement", "command_name": "RemoveRoundArea", "paras": { "areaIds": [ 1 ] } } ``` 请求参数 paras字段同协议中消息的映射关系 表23参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | areaIds | stringList | 区域ID列表 | / | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表24参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 车辆管理-设置多边形区域电子围栏 接口说明 请求对应的消息ID：0x8604 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "VehicleManagement" "command_name": "SetPolygonArea", "paras": { "areaId": 1, "areaProperty": 1, "startTime": "211119170110", "endTime": "211119170111", "maxSpeed": 0, "durationOverSpeed": 0, "vertices": [ { "latitude": 0, "longitude": 1 } ], "maxNightSpeed": 0, "areaName": "test" } } ``` 请求参数 paras字段同协议中消息的映射关系 表25参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | areaId | int | 区域ID | **参数说明：**区域ID | | areaProperty | int | 区域属性 | **参数说明：**区域属性 | | startTime | string | 起始时间 | **参数说明：**格式为YYMMDDHHMMSS | | endTime | string | 结束时间 | **参数说明：**格式为YYMMDDHHMMSS | | vertices | jsonObject | 区域定点 | **参数说明：**多边形区域定点信息 | | maxSpeed | int | 最高速度 | **参数说明：**单位为千米每小时（km/h） | | durationOverSpeed | int | 超速持续时间 | **参数说明：**单位为秒（s） | | maxNightSpeed | int | 夜间最高速度 | **参数说明：**单位为千米每小时（km/h） | | areaName | string | 区域名称 | **参数说明：**区域的名称描述 | vertice字段同协议中消息的映射关系 表26参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | latitude | int | 中心点纬度 | **参数说明：**以度为单位的纬度值乘以10的6次方，精确到百万分之一。 | | longitude | int | 中心点经度 | **参数说明：**以度为单位的经度值乘以10的6次方，精确到百万分之一。 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表27参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 车辆管理-删除多边形区域电子围栏 接口说明 请求对应的消息ID：0x8605 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "service_id": "VehicleManagement", "command_name": "RemovePolygonArea", "paras": { "areaIds": [ 1 ] } } ``` 请求参数 paras字段同协议中消息的映射关系 表28参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | areaIds | stringList | 区域ID列表 | / | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表29参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 实时音视频-实时音视频传输请求 接口说明 请求对应的消息ID：0x9101 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "command_name": "VideoLiveRequest", "service_id": "VideoLive", "paras": { "serverIp": "***.***.***.***", "port": 8557, "channelNo": 1, "dataType": 0, "streamType": 0 } } ``` 请求参数 paras字段同协议中消息的映射关系 表30参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | serverIp | string | 服务器地址 | **参数说明：**视频服务器地址 | | port | int | 服务器端口 | **参数说明：**视频服务器端口 | | channelNo | int | 逻辑通道号 | **参数说明：**逻辑通道号 | | dataType | int | 音视频资源类型 | **参数说明：**音视频资源类型 0：音视频， 1：视频 2：双向对讲 3：监听 4：中心广播 5：透传 | | streamType | int | 码流类型 | **参数说明：**码流类型 0：主码流1：子码流 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表31参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | **参数说明：**应答流水号 | | msgId | int | **参数说明：**对应的平台的消息ID | | resultCode | int | **参数说明：**结果 | #### 实时音视频-音视频实时传输控制 接口说明 请求对应的消息ID：0x9102 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "command_name": "VideoLiveControl", "service_id": "VideoLive", "paras": { "channelNo": 1, "commandId": 0, "mediaType": 0, "streamType": 1 } } ``` 请求参数 paras字段同协议中消息的映射关系 表32参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | channelNo | int | 逻辑通道号 | **参数说明：**逻辑通道号 | | commandId | int | 控制指令 | **参数说明：**平台可以通过该指令对设备的实时音视频传输进行控制： 0：关闭音视频传输指令。 1：切换码流 2：暂停该通道所有流的发送 3：恢复暂停前流的发送 4：关闭所向对讲 | | mediaType | int | 关闭音视频资源类型 | **参数说明：**关闭音视频资源类型 0：关闭该通道有关的音视频数据 1：只关闭该通道有关的音频，保留该通道有关的视频。 2：只关闭该通道有关的视频，保留该通道有关的音频。 | | streamType | int | 码流类型 | **参数说明：**将之前申请的码流切换为新申请的码流，音频与切换前保持一致。新申请的码流为： 0：主码流 1：子码流 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` #### 实时音视频-查询视频资源列表 接口说明 请求对应的消息ID：0x9205 响应对应的消息ID：0x1205 请求示例 ``` { "command_name": "GetVideoResource", "service_id": "VideoResource", "paras": { "channelNo": 0, "startTime": "220314093900", "endTime": "220314174000", "warningMark":0, "warningMarkHigh":0, "mediaType": 0, "streamType": 0, "memoryType": 0 } } ``` 请求参数 paras字段同协议中消息的映射关系 表33参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | channelNo | int | 逻辑通道号 | 0标识所有通道 | | startTime | string | 开始时间 | YYMMDDHHMMSS，全0表示无起始时间 | | endTime | string | 结束时间 | YYMMDDHHMMSS，全0表示无结束时间 | | warningMark | int | 告警标志 | 告警标志位定义，全0表示无报警类型条件 | | warningMarkHigh | int | 高位告警标志 | 高位告警标志位定义，全0表示无报警类型条件 | | mediaType | int | 音视频资源类型 | 0：音视频，1：音频，2：视频3：视频或者音视频 | | streamType | int | 码流类型 | 0：所有码流1：主码流2：子码流 | | memoryType | int | 存储器类型 | 0：所有存储器，1：主存储器，2：灾备存储器 | 响应示例 ``` { "command_id": "c4eafd52-7411-483d-901c-858a2b7bc2a7", "response": { "paras": { "flowNo": 0, "count": 1, "items": [ { "channelNo": 1, "startTime": "200101000000", "endTime": "201231235959", "warningMark": 0, "warningMarkHigh": 0, "mediaType": 1, "streamType": 1, "memoryType": 1, "size": 1024 } ] }, "response_name": null, "result_code": 0 } } ``` 响应参数 paras字段定义 表34参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | 应答流水号 | | count | int | 录像文件数量 | | items | jsonObject | 录像列表 | 录像文件说明 表35参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | channelNo | int | 逻辑通道号 | 0标识所有通道 | | startTime | string | 开始时间 | YYMMDDHHMMSS格式的视频开始时间 | | endTime | string | 结束时间 | YYMMDDHHMMSS 式的视频结束时间 | | warningMark | int | 告警标志 | 告警标志位定义 | | warningMarkHigh | int | 高位告警标志 | 高位告警标志位定义 | | mediaType | int | 音视频资源类型 | 0：音视频，1：音频，2：视频3：视频或者音视频 | | streamType | int | 码流类型 | 0：所有码流1：主码流2：子码流 | | memoryType | int | 存储器类型 | 0：所有存储器，1：主存储器，2：灾备存储器 | #### 历史视频上传 接口说明 请求对应的消息ID：0x9206 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "command_name": "Upload", "service_id": "VideoResource", "paras": { "serverIp": "***.***.***.***", "port": 10020, "username": "******", "password": "******", "path": "20220307", "channelNo": 1, "startTime": "220307153900", "endTime": "220307154000", "warningMark":0, "warningMarkHigh":0, "mediaType": 0, "streamType": 1, "memoryType": 1, "condition": 7 } } ``` 请求参数 paras字段同协议中消息的映射关系 表36参数描述 | 字段名 | 类型 | 协议字段 | 参数描述 | |:---|:---|:---|:---| | serverIp | string | 服务器地址 | FTP服务器地址 | | port | int | 服务器端口 | FTP服务器端口 | | username | string | 用户名 | FTP服务器用户名 | | password | string | 密码 | FTP服务器密码 | | path | string | 文件上传路径 | FTP服务器文件上传路径 | | channelNo | int | 逻辑通道号 | 标识所有通道 | | startTime | string | 开始时间 | YYMMDDHHMMSS格式的起始时间 | | endTime | string | 结束时间 | YYMMDDHHMMSS格式的结束时间 | | warningMark | int | 告警标志 | 告警标志位定义 | | warningMarkHigh | int | 高位告警标志 | 高位告警标志位定义 | | mediaType | int | 音视频资源类型 | 0：音视频，1：音频，2：视频3：视频或者音视频 | | streamType | int | 码流类型 | 0：所有码流1：主码流2：子码流 | | memoryType | int | 存储器类型 | 0：所有存储器，1：主存储器，2：灾备存储器 | | condition | int | 任务执行条件 | Bit0：WIFI，为1时表示WI-FI下可下载； Bit1：LAN，为1时表示LAN连接时可下载； Bit2:3G/4G, 为1时表示3G/4G连接时可下载。 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表37参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | 应答流水号 | | msgId | int | 对应的平台的消息ID | | resultCode | int | 结果 | #### 文本信息下发接口说明 请求对应的消息ID：0x8300 响应对应的消息ID：0x0001（终端通用响应） 请求示例 ``` { "command_name": "SendTextMessage", "service_id": "Message", "paras": { "flag": 2, "lcdflag": true, "ttsflag": true, "text": "hello", "textType": 1 } } ``` 请求参数 paras字段同协议中消息的映射关系 表38参数描述 | 属性名 | 协议字段 | 类型 | 参数描述 | |:---|:---|:---|:---| | flag | 文本信息标志 | int | 1： 服务 2： 紧急 3： 通知 | | lcdflag | 终端显示标志 | boolean | 为true时终端显示器显示 | | ttsflag | 终端播读标志 | boolean | 为true时终端TTS播读 | | textType | 文本类型 | int | 1：通知 2：服务 | | text | 文本信息 | string | 最长1024字节 | 响应示例 ``` { "command_id": "1641969363120826882", "response": { "paras": { "flowNo": 0, "msgId": 33027, "resultCode": 0 }, "result_code": 0 } } ``` 响应参数（终端通用响应） paras字段定义 表39参数描述 | 字段名 | 类型 | 参数描述 | |:---|:---|:---| | flowNo | int | 应答流水号 | | msgId | int | 对应的平台的消息ID | | resultCode | int | 结果 |