应用侧对接

属性上报

以下消息转换为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"
        }
      ]
    }
  }
}

同步命令

以下消息类型，应用可以通过下发同步命令的方式，给终端设备发送消息，参考下发同步命令。

请使用API接口做业务调测，部分命令目前不能通过界面下发。

终端管理-设置终端参数

接口说明

请求对应的消息ID：0x8103

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
  "service_id": "TerminalManagement",
  "command_name": "SetTerminalParameters",
  "paras": {
    "parameters": {
      "1": 120
    }
  }
}

请求参数

paras字段定义

响应示例

{
    "command_id": "1641969363120826882",
    "response": {
        "paras": {
            "flowNo": 0,
            "msgId": 33027,
            "resultCode": 0
        },
        "result_code": 0
    }
}

响应参数（终端通用响应）

paras字段定义

终端管理-查询终端参数

接口说明

请求对应的消息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字段定义

终端管理-查询指定终端参数

接口说明

请求对应的消息ID：0x8106

响应对应的消息ID：0x0104

请求示例

{
    "service_id": "TerminalManagement",
    "command_name": "QueryAssignedTerminalParameters",
    "paras": {
        "parameterIds": [1]
    }
}

请求参数

paras字段定义

响应示例

{
    "command_id": "1641973633890258246",
    "response": {
        "paras": {
            "flowNo": 0,
            "total": 1,
            "parameters": {
                "1": 120
            }
        },
        "result_code": 0
    }
}

响应参数

paras字段定义

终端管理-终端控制

接口说明

请求对应的消息ID：0x8105

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "service_id": "TerminalManagement",
    "command_name": "TerminalControl",
    "paras": {
        "commandId": 4,
        "parameter": null
    }
}

请求参数

paras字段定义

响应示例

{
    "command_id": "1641970324270870620",
    "response": {
        "paras": {
            "flowNo": 0,
            "msgId": 33029,
            "resultCode": 0
        },
        "result_code": 0
    }
}

响应参数（终端通用响应）

paras字段定义

终端管理-查询终端属性

接口说明

请求对应的消息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字段定义

位置及报警-位置信息查询

接口说明

请求对应的消息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
    }
}

响应参数

位置及报警-临时位置跟踪控制

接口说明

请求对应的消息ID：0x8202

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "service_id": "Location",
    "command_name": "LocationTrace",
    "paras": {
        "timeInterval": 10,
        "period": 20
    }
}

请求参数

paras字段定义

响应示例

{
    "command_id": "1641971752394383473",
    "response": {
        "paras": {
            "flowNo": 0,
            "msgId": 33282,
            "resultCode": 0
        },
        "result_code": 0
    }
}

响应参数

paras字段定义

位置及报警-人工确认报警信息

接口说明

对应的消息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字段定义

响应示例

{
    "command_id": "1641971845905632317",
    "response": {
        "paras": {
            "flowNo": 0,
            "msgId": 33283,
            "resultCode": 0
        },
        "result_code": 0
    }
}

响应参数

paras字段定义

位置及报警-链路检测

接口说明

请求对应的消息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字段定义

车辆管理-设置圆形区域电子围栏

接口说明

请求对应的消息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字段同协议中消息的映射关系

Area字段说明

区域属性说明

响应示例

{
    "command_id": "1641971911322353065",
    "response": {
        "paras": {
            "flowNo": 0,
            "msgId": 33284,
            "resultCode": 0
        },
        "result_code": 0
    }
}

响应参数（终端通用响应）

paras字段定义

车辆管理-删除圆形区域电子围栏

接口说明

请求对应的消息ID：0x8601

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "service_id": "VehicleManagement",
    "command_name": "RemoveRoundArea",
    "paras": {
        "areaIds": [
            1
        ]
    }
}

请求参数

paras字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义

车辆管理-设置多边形区域电子围栏

接口说明

请求对应的消息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字段同协议中消息的映射关系

vertice字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义

车辆管理-删除多边形区域电子围栏

接口说明

请求对应的消息ID：0x8605

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "service_id": "VehicleManagement",
    "command_name": "RemovePolygonArea",
    "paras": {
        "areaIds": [
            1
        ]
    }
}

请求参数

paras字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义

实时音视频-实时音视频传输请求

接口说明

请求对应的消息ID：0x9101

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "command_name": "VideoLiveRequest",
    "service_id": "VideoLive",
    "paras": {
        "serverIp": "***.***.***.***",
        "port": 8557,
        "channelNo": 1,
        "dataType": 0,
        "streamType": 0
    }
}

请求参数

paras字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义

实时音视频-音视频实时传输控制

接口说明

请求对应的消息ID：0x9102

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "command_name": "VideoLiveControl",
    "service_id": "VideoLive",
    "paras": {
        "channelNo": 1,
        "commandId": 0,
        "mediaType": 0,
         "streamType": 1
    }
}

请求参数

paras字段同协议中消息的映射关系

响应示例

{ 
    "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字段同协议中消息的映射关系

响应示例

{
    "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字段定义

录像文件说明

历史视频上传

接口说明

请求对应的消息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字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义

文本信息下发接口说明

请求对应的消息ID：0x8300

响应对应的消息ID：0x0001（终端通用响应）

请求示例

{
    "command_name": "SendTextMessage",
    "service_id": "Message",
    "paras": {
        "flag": 2,
        "lcdflag": true,
        "ttsflag": true,
        "text": "hello",
        "textType": 1
    }
}            

请求参数

paras字段同协议中消息的映射关系

响应示例

{ 
    "command_id": "1641969363120826882", 
    "response": { 
        "paras": { 
            "flowNo": 0, 
            "msgId": 33027, 
            "resultCode": 0 
        }, 
        "result_code": 0 
    } 
}

响应参数（终端通用响应）

paras字段定义