智能车联平台接口文档

修订历史

平台接口

查询在线车辆

接口描述：查询在线车辆，以终端跟车联网平台建立连接为依据

接口地址：http://ip:port/v2x-server/api/v1/platform/vehicle/online

请求方式：GET

请求参数：无

响应参数：

响应示例:

{
    "success": true,
    "data": [
        {
            "cellPhoneNumber": "188888888888",
            "plateNumber": "测A00010",
            "plateColor": 2
        }
    ]
}

查询终端属性

接口描述：查询终端属性

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/property

请求方式：GET

请求参数：无

响应参数：

响应示例:

{
    "success": true,
    "data": {
        "cellPhoneNumber": "188888888888",
        "terminalType": 65399,
        "manufacturerId": "71102",
        "terminalModel": "MDJ7100",
        "terminalId": "1111111",
        "terminalSimIccId": "89860621260005753058",
        "hardwareVersion": "V1.0",
        "firmwareVersion":"V2.616.0024.0",
        "gnssPartProperty": 51,
        "communicationPartProperty": 255,
         "transportType":1,
         "dangerType":1,
         "freightType":1,
         "rentType":1,
         "videoType":1,
         "overallType":1
    }
}   

查询终端参数

接口描述：查询终端参数，包含主动安全类

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/param

请求方式：GET

请求参数：无

响应参数：

响应示例:

{
    "success": true,
    "data": [
        {
            "id": 1,
            "description": "终端心跳发送间隔，单位为秒(s)",
            "value": 20
        },
        {
            "id": 2,
            "description": "TCP消息应答超时时间，单位为秒(s)",
            "value": 10
        },
        {
            "id": 3,
            "description": "TCP消息重传次数",
            "value": 3
        },
        {
            "id": 18,
            "description": "主服务器无线通信拨号密码",
            "value": "123456"
        },
        {
            "id": 62308,
            "description": "高级驾驶辅助系统参数",
            "value": [
                {
                    "id": 0,
                    "description": "报警触发速度阈值",
                    "value": 45
                },
                {
                    "id": 1,
                    "description": "报警提示音量",
                    "value": 2
                },
                {
                    "id": 2,
                    "description": "主动拍照策略",
                    "value": 0
                }
            ]
        },
        {
            "id": 62309,
            "description": "驾驶员状态监测系统参数",
            "value": [
                {
                    "id": 0,
                    "description": "报警触发速度阈值",
                    "value": 30
                },
                {
                    "id": 1,
                    "description": "报警音量",
                    "value": 6
                },
                {
                    "id": 2,
                    "description": "主动拍照策略",
                    "value": 0
                }
            ]
        }
    ]
}

查询指定终端参数

接口描述：查询指定终端参数，包含主动安全类

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/param_designated

请求方式：GET

请求参数：

响应参数：参照查询终端参数

返回示例：参照查询终端参数

设置终端参数

接口描述：查询指定终端参数，包含主动安全类（DSM暂不支持，请勿设置）

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/param_setup

请求方式：PUT/JSON

请求参数：

请求示例：

[
    {
        "id": 1,
        "value": 20
    },
    {
        "id": 2,
        "value": 10
    },
    {
        "id": "62308",
        "value": [
            {
                "id": 0,
                "value": 45
            },
            {
                "id": 1,
                "value": 2
            }
        ]
    }
]

响应参数：success：true 表示本次请求成功

响应示例：

{
    "success": true,
    "data": "成功/确认"
}

文本信息下发

接口描述：文本信息下发，通过发送文本信息下发消息，按指定方式通知驾驶员

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/message_send

请求方式：POST/JSON

请求参数：

请求示例：

{
    "display": 1,
    "tts": 1,
    "screenDisplay": "1",
    "message": "test"
}

响应参数：success：true 表示本次请求成功

响应示例：

{
    "success": true,
    "data": "成功/确认"
}

文本信息下发(批量)

接口描述：文本信息下发，通过发送文本信息下发消息，按指定方式通知驾驶员

接口地址：http://ip:port/v2x-server/api/v1/terminal/message_send

请求方式：POST/JSON

请求参数：

请求示例：

{
    "display": 1,
    "tts": 1,
    "screenDisplay": "1",
    "message": "test",
    "mobileNumbers":["18888888888","12321321321321"]
}

响应参数：success：true 表示本次请求成功

响应示例：

{
    "success": true,
    "data": {
          //成功的号码
          "success": ["11888888888"],
           //失败的号码
          "fail":["12313123213123"]
                  
    }
}

摄像头立即拍摄

接口描述：摄像头立即拍摄，支持定时、定量拍摄，接口响应时间受拍摄数量及设备上传速度影响，不建议大量拍摄

存储服务：OSS

储存空间：linkcld-swc

目录: shoot

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/shoot

请求方式：POST/JSON

请求参数：

请求示例：

{
    "channelId": 2
}

响应参数：success：true 表示本次请求成功；data：图片名称

响应示例：

{
    "success": true,
    "data": [
        "1888888888881629207952403.jpg"
    ]
}

查询驾驶员身份信息

接口描述：上报驾驶员身份信息请求

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/driver

请求方式：GET

请求参数：无

响应参数：

响应示例：

{
    "success": true,
    "data": {
        "cellPhoneNumber": "188888888888",
        "state": 1,
        "dateTime": "210817192117",
        "result": 0,
        "driverName": "张三",
        "certificationCoding": "0123456",
        "authorityName": "",
        "expiredDate": "00000000"
    }
}

终端控制

接口描述：终端控制

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/control

请求方式：POST/PARAM

请求参数：

响应参数：success：true 表示本次请求成功

响应示例：

{
    "success": true,
    "data": "成功/确认"
}

查询资源列表

接口描述：查询资源列表，按照音视频类型、通道号、报警类型和起止时间等组合条件从终端中查询录像文件列表

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/histvList

请求方式：POST/JSON

请求参数：

响应参数：

响应示例：

{
    "success": true,
    "data": [
        {
            "channelNumber": 2,
            "startTime": "210816000000",
            "endTime": "210816010000",
            "dataType": 0,
            "streamType": 1,
            "storageType": 1,
            "fileSize": 53673984
        },
        {
            "channelNumber": 2,
            "startTime": "210816010000",
            "endTime": "210816020000",
            "dataType": 0,
            "streamType": 1,
            "storageType": 1,
            "fileSize": 53477376
        },
        {
            "channelNumber": 2,
            "startTime": "210816020000",
            "endTime": "210816030000",
            "dataType": 0,
            "streamType": 1,
            "storageType": 1,
            "fileSize": 53673984
        }
    ]
}

文件上传

接口描述：文件上传，向终端下发文件上传命令，终端通过 FTP 方式将文件上传到目标 FTP 服务器 的指定路径

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/histv_upload

请求方式：POST/JSON

请求参数：

响应参数：success：true 表示本次请求成功；data：文件位置，文件存储方式为一文件对应一目录，可根据文件位置获取文件

响应示例：

{
    "success": true,
    "data": "/sub800bdc743d4e469996c840bcb9f39d6e"
}

消息中间件交互类消息

智能车联平台与业务平台消息交互采用消息中间件：RocketMQ，消息类型、主题及标签见下表

定位消息数据格式：保持不变

注册消息数据格式：

{
    "cid": 108,
    "cpn": "188888888888",
    "mid": "71102",
    "pc": 1,
    "pid": 33,
    "pn": "11111",
    "receivedTime": 1629206041307,
    "tid": "1111111"
}

IC 卡插拔消息数据格式：

{
    "an": "",
    "cc": "123456",
    "cpn": "188888888888",
    "dn": "",
    "dt": "210817192117",
    "ed": "00000000",
    "res": 0,
    "sta": 1
}

高级驾驶辅助系统报警信息（待补充）

驾驶员状态监测系统报警信息数据格式（待补充）

盲区监测系统报警信息：（待补充）

文件上传结束（待补充）

行驶记录数据采集

接口描述：平台通过发送行驶记录数据采集命令消息，要求终端上传指定的数据，该消息需要终端 回复行驶记录数据上传消息。

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/get_driving_recorder_info

请求方式：GET

请求参数：

命令字详细示例以及其对应的返回值示例：

命令字 2 查询 记录仪实时时钟；

currentTime（Date）字段为实时时钟时间值

{
    "success": true,
    "data": {
        "startPrefix": 21882,
        "commandWord": 2,
        "dataLength": 6,
        "reservedWord": 0,
        "checkByte": 44,
        "currentTime": "2021-10-26 10:25:25"
    }
}

命令字 4 查询 车辆特征系数（脉冲系数）

impulseCoefficient（Integer） 字段为脉冲系数

{
    "success": true,
    "data": {
        "startPrefix": 21882,
        "commandWord": 4,
        "dataLength": 8,
        "reservedWord": 0,
        "checkByte": 45,
        "currentTime": "2021-10-26 10:25:51",
        "impulseCoefficient": 6500
    }
}

命令字 5 查询 车牌号、车架号、车辆类型

vehicleIdentificationNumber（String） 字段为车架号

vehicleNumber（String） 字段为车牌号

vehicleNumberClassification（String） 字段为车辆类型

行驶记录参数下传

接口描述：平台通过发送行驶记录参数下传命令消息，要求终端上传指定的数据，该消息要求终端 回复终端通用应到消息。

接口地址：http://ip:port/v2x-server/api/v1/terminal/{cellPhoneNumber}/send_driving_recorder_param

请求方式：PUT/PARAM

请求参数：

命令字与所需要对应的参数

车辆类型枚举:

1.客运车辆

2.危险品车辆

3.货运车辆

4.出租汽车

5.其他

响应示例：

{
    "success": true,
    "data": {
        "serialNumber": 42,
        "id": 34561,
        "result": 0
    }
}