版本：1.0.7
| 作者： | 日期： | 2019-01-24 | |
| 审批： | 日期： |
变更记录：
| 日期 | 版本 | 变更说明 | 作者 |
| 2019/01/24 | 1.0．2 | 在1.0.1基础上面调整 1)获取数机构车辆加上terminal(设备号），channeltotals（摄像头通道总数）字段 | 伍永德 |
| 2021/01/25 | 1.0．4 | 增加载重，删除老版本接口 | 邓铁山 |
| 2022/6/7 | 1.0.5 | 增加人脸识别结果API | 罗来志 |
| 2022/12/15 | 1.0.5 | 增加拍照接口 | 罗来志 |
目录
API接口文档
版本：1.0.6
1 概述
1.1 注意事项
1.2 签名规则
1.3 公共参数
2 API接口
2.1 用户登陆
2.2 用户注销
2.3 请求方式
2.4 获取用户机构车辆树
2.5 实时视频播放请求
2.6 实时音视频控制
2.7 视频基本参数设置
2.8 获取设备在线状态
2.9 根据车辆获取设备信息列表
2.10 根据设备号获取设备信息
2.11 获取设备历史轨迹
2.12 查询设备历史录像列表
2.13 录像回放请求
2.14 录像回放控制
2.15 文本信息下发
2.16 文本信息下发记录
2.17 文件上传
2.18 文件上传控制
2.19 文件上传记录查询
2.20 获取文件服务器参数
2.21 根据设备号获取设备状态
2.22 终端控制
2.23 位置跟踪
2.24 获取指定公司下所有的车辆列表
2.25 查询终端属性
2.26 获取设备报警实时状态
2.27 获取设备报警分页列表
2.28 设备报警处理
2.29 获取设备GPS
2.30 获取报警屏蔽信息
2.31 获取报警分类信息
2.32 设置报警屏蔽信息
2.33 设备报警解除
2.34 获取设备载重事件
2.35 人脸识别记录
2.36 摄像头立即拍摄命令
2.37 websocket报警信息
2.38 主动安全报警列表
2.39 主动安全报警详情
3 附件1
3.1 报警ID定义
接口说明描述中API接口详细说明，细化每一个功能详细业务流程为后续开发提供一个详细的参考。
本文档提供给开发人员及项目相关人员参考阅读。
所有api接口参数都采用UTF-8格式进行编码
URL格式为 http://服务器IP（或者域名）:端口号（默认为8088)/cmsapi/接口名
如: www.liveoss.com 服务器的登陆接口URL格式为 :
http://www.liveoss.com:8088/cmsapi/userLogin
每个接口中的sign参数采用md5进行加密签名，签名参 数:username+password（MD5加密）+tradeno
比如：用户名是admin,密码是123456，用户密码签名后的结果是: E10ADC3949BA59ABBE56E057F20F883E流水号20180908180001，则
sign= MD5Encode
("adminE10ADC3949BA59ABBE56E057F20F88320180908180001")
sign=37003F0CEA3B2BAB021732D0EDF15F8A就是签名参数的值。
每个接口请求都包括下面三个参数：
| username | 用户名 | string | 是 | 平台用户名 |
| tradeno | 流水号 | string | 是 | 客户端自由定，可以取时间戳 |
| sign | 签名 | string | 是 | 详细见签名规则 |
每个接口返回都包括下面三个参数：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 返回数据 | List | 业务数据 |
POST请求，参数采用JSON形式发送字符串，可以在线测试接口：在线http post,get接口测试请求工具online,在线post,在线get,在线接口测试,api在线,生成文档,生成markdown文档,utf,gbk,转码-在线工具-postjson
JAVA代码请求示例：
/**
* 发送post请求
* @param url 请求路径
* @param param 请求json数据
* @return
*/
public static String doJsonPost(String url,String jsonParam){
System.out.println("JSON请求URL:\n"+url+",参数:\n"+jsonParam);
HttpPost httpPost = null;
String result = null;
try{
HttpClient client = new SSLClient();
httpPost = new HttpPost(url);
if(jsonParam != null){
StringEntity se = new StringEntity(jsonParam.toString(),"utf-8");
httpPost.setEntity(se); //post方法中，加入json数据
httpPost.setHeader("Content-Type","application/json");
}
HttpResponse response = client.execute(httpPost);
if(response != null){
HttpEntity resEntity = response.getEntity();
if(resEntity != null){
result = EntityUtils.toString(resEntity,"utf-8");
}
}
}catch(Exception ex){
ex.printStackTrace();
}
System.out.println("JSON请求返回结果:\n"+result);
return result;
}
根据用户名和密码登录平台。
http://www.liveoss.com:8088/cmsapi/userLogin
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| password | 密码 | String | 是 | 平台账号密码(MD5加密后结果) |
JSON参数：
{
"password": " E10ADC3949BA59ABBE56E057F20F883E",
"sign": "37003F0CEA3B2BAB021732D0EDF15F8A",
"tradeno": "20180908180001",
"username": "admin"
}
"errCode": 0,
"resultMsg": "成功",
"resultData": "1"
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 用户id | String | userid，后续接口用到当做参数 |
用户注销。
http://www.liveoss.com:8088/cmsapi/userExit
无
JSON参数：
{
"sign": "37003F0CEA3B2BAB021732D0EDF15F8A",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
获取用户下面的机构车辆数，树形结构显示机构信息、车辆信息。
http://www.liveoss.com:8088/cmsapi/deptTree
无
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": null,
"nodeId": "1",
"parentId": "0",
"nodeName": "车辆管理平台",
"nodetype": 1,
"carstatus": null,
"total": 1216,
"caroffline": 996,
"longoffline": 219,
"channeltotals": null,
"parent": false,
"gbid": “34020000001320000001”,
"channels":{
{chanel_id:1,
"gbid":"34020000001310000005",
},
{chanel_id:2,
"gbid":"34020000001320000006",
},
{chanel_id:3,
"gbid":"34020000001320000007",
},
{chanel_id:4,
"gbid":"34020000001320000008",
}
}
}, {
"terminal": "10000001000",
"nodeId": "537749290123132928",
"parentId": null,
"nodeName": "粤B61000",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false,
"gbid": “34020000001320000002”,
"channels":{
{chanel_id:1,
"gbid":"34020000001310000001",
},
{chanel_id:2,
"gbid":"34020000001320000002",
},
{chanel_id:3,
"gbid":"34020000001320000003",
},
{chanel_id:4,
"gbid":"34020000001320000004",
}
}
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 数据列表 | List | 见下表 |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| nodeId | 节点id | string | 车辆id/机构id |
| parentId | 父级节点 | string | |
| nodeName | 节点名称 | string | 车牌号/机构名称 |
| nodetype | 节点类型 | int | 1组织机构 2 车辆 |
| carstatus | 车辆状态 | int | 节点是车辆才有值 车辆状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 |
| total | 机构车辆总数 | int | 包括子机构数量 |
| caroffline | 车辆离线总数 | int | 包括子机构数量 |
| longoffline | 车辆长离总数 | int | 包括子机构数量 |
| terminal | 终端号 | string | 节点类型2有值 |
| channeltotals | 摄像头个数 | int | 节点类型2有值 |
| parent | 是否是父节点 | boolean | true代表有子节点，false代表无 |
| gbid | 国标编码 | string | 用于平台转发到国标服务器 |
| Channels | 通道国标编码 | Json | 通道设备编码列表 |
| toGb28181 | 转发GB28181 | int | 1转发 |
根据设备号播放视频
接口流程：
实时预览：下发音视频传输请求指令。
http://www.liveoss.com:8088/cmsapi/playSend
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 |
| vedioType | 类型 | String | Y | 0：音视频 1视频 2 双向对讲 3 监听 4 中心广播5 透传 |
| id | 通道id | String | Y | 通道号 1至32 |
| protocol | 视频协议 | String | Y | 0：RTSP 1: RTMP 2:RTP 3： 其他 |
| streamType | 码流类型 | int | Y | 0:主码流 1：子码流 |
{
"id": "1",
"protocol": "1",
"sign": "37003F0CEA3B2BAB021732D0EDF15F8A",
"streamType": 1,
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin",
"vedioType": 0
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"streamip": "120.76.235.109",
"streamport": "10077",
"url": "rtmp://120.76.235.109:10077/live/15814403512_channel_1"
“ws":"ws://car-eye.cn:4025/ws?port=10077&app=live&stream=13751093 611_channel_1",
"http"：
"http://car-eye.cn:4025/flv?port=10077&app=live&stream=13751093611_cha nnel_1",
"https"：
"https://car-eye.cn:4025/flv?port=10077&app=live&stream=13751093611_ch a nnel_1",
"wss"：
"wss://car-eye.cn:4025/wss?port=10077&app=live&stream=13751093611_ch a nnel_1",
"pushTalkWss"：
"wss://car-eye.cn:9210/websocket/data/"
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData:
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| streamip | 流媒体ip | string | |
| streamport | 流媒体端口 | string | |
| url | 播放地址 | string | Rtmp 播放地址 |
| http | 播放地址 | string | http-flv 播放地址 |
| ws | 播放地址 | string | Ws-flv 播放地址 |
| https | 播放地址 | string | https-flv 播放地址 |
| wss | 播放地址 | string | Wss-flv 播放地址 |
| pushTalkWss | 对讲推送地址 | string | Wss推送地址 |
进行音视频通信控制。此接口可以不用，可以直接调用播放和停止视频接口，类型选择停 止预览就行。
http://www.liveoss.com:8088/cmsapi/vedioControll
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 |
| logicChannel | 逻辑通道号 | int | Y | 逻辑通道号 |
| command | 命令字 | int | Y | 0：关闭音视频传输 1：切换码流（增加暂停和继续） 2：暂停该通道所有流的发送 3：恢复暂停流的发送，与暂停前流格式保持一致 4：关闭双向对讲 |
| closeType | 类型 | int | Y | 0：关闭该通道有关的音视频流 1：只关闭该通道的音频保留视频 2：只关闭该通道的视频保留音频 |
| switchType | 切换码流类型 | int | Y | 切换后视频与新的码流类型保持一致，音频不变 0：主码流 1：子码流 |
{
"closeType": 0,
"command": 0,
"logicChannel": "1",
"sign": "37003F0CEA3B2BAB021732D0EDF15F8A",
"switchType": 0,
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
获取设备在线状态。
http://www.liveoss.com:8088/cmsapi/getCarStatus
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 否 | 设备号 可以是多个，以','分割。 如果为空，则判断车牌号。 |
| carnumber | 车牌号 | String | 否 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512,18668171282",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": "15814403512",
"carnumber": "粤B03512",
"carstatus": 1
}, {
"terminal": "18668171282",
"carnumber": "粤B71282",
"carstatus": 2
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| terminal | 设备号 | String | |
| carnumber | 车牌号 | String | |
| carstatus | 车辆状态 | int | 节点是车辆才有值 车辆状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 |
根据车辆获取设备信息状态。
http://www.liveoss.com:8088/cmsapi/getTerminalStatus
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| carid | 车辆id | String | 否 | Carid和carnumber不能同时为空 |
| carnumber | 车牌号 | String | 否 |
JSON参数：
{
"carnumber": "粤B03512",
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": "15814403512",
"carnumber": "粤B03512",
"carstatus": 2
}, {
"terminal": "13700000007",
"carnumber": "粤B03512",
"carstatus": 2
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| terminal | 设备号 | String | |
| carnumber | 车牌号 | String | |
| carstatus | 车辆状态 | int | 节点是车辆才有值 车辆状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 |
根据设备号获取设备信息。
http://www.liveoss.com:8088/cmsapi/getTerminalInfo
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"deptList": null,
"id": "1",
"userid": "430130351050981376",
"deptid": "430130351025815552",
"terminal": "15814403512",
"carid": "430130351176810496",
"devicetype": "1",
"deviceno": "12223332133",
"factorytype": 21,
"companyname": "厂家",
"sim": "15200121102",
"iccid": "00010022",
"oneline": 2,
"status": 2,
"remark": null,
"bk1": null,
"bk2": null,
"isDelete": 0,
"createDate": 1538126199000,
"createUser": "admin",
"modifyDate": 1538126197000,
"modifyUser": "admin",
"devicetypename": null,
"deptname": null,
"carnumber": null
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 | |
| id | id号码 | String | ||
| deptid | 组织机构 | String | ||
| userid | 用户id | int | ||
| terminal | 设备编码 | 实际设备关键字 | ||
| carid | 车辆id | 外键 | ||
| devicetype | 设备类型 | 外键（设备类型） | ||
| deviceno | 设备编号 | jt808注册用的用户自己定义的设备编号 | ||
| factorytype | 厂家类型 | 厂家类型 0 表示未知 ,17表示gm,20表示hd 21 表示fze ,23表示hb,24表示bsj 26表示hk ,28表示yx,29表示rm | ||
| companyname | 厂商名字 | 设备厂家名字 | ||
| sim | sim卡号 | 对3g/4g设备有效 | ||
| iccid | 手机卡ICCID | |||
| oneline | 设备是否在线 | 设备是否在线(根据网络是否定位判断是否在线) 1在线 2离线 | ||
| status | 当前状态 | 1长时间离线2离线3 熄火4停车 5 行驶 6 报警 7在线 8 未定位 默认：1 | ||
获取设备历史轨迹数据。
http://www.liveoss.com:8088/cmsapi/getHistoryTrack
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 否 | 选填 |
| carnumber | 车牌号 | String | 否 | 选填 |
| startTime | 开始时间 | String | 是 | 如：2018-03-17 11:49:51 |
| endTime | 结束时间 | String | 是 |
JSON参数：
{
"endTime": "2018-03-17 11:50:21",
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-03-17 11:49:51",
"terminal": "13700000007",
"tradeno": "20180908180001",
"username": "admin"，
"carnumber": "测B11122"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"tName": null,
"id": "424534944635813888",
"carid": "384373323083153408",
"deptid": "1",
"deptname": "总公司",
"msgid": 512,
"seq": 57,
"lng": 114.023233,
"lat": 22.739148,
"altitude": "0",
"speed": "0",
"direction": "0",
"mileage": 0.0,
"summileage": 0.0,
"gpstime": "180317115016",
"gpsflag": 1,
"createtime": "2018-03-17 11:50:16",
"province": "广东省",
"city": "深圳市",
"district": "龙华区",
"carstatus": 4,
"weight": 1.0,
"weightAd": 38000
}, {
"tName": null,
"id": "424534902780854272",
"carid": "384373323083153408",
"deptid": "1",
"deptname": "总公司",
"msgid": 512,
"seq": 56,
"lng": 114.023233,
"lat": 22.739148,
"altitude": "0",
"speed": "0",
"direction": "0",
"mileage": 0.0,
"summileage": null,
"gpstime": "180317115006",
"gpsflag": 1,
"createtime": "2018-03-17 11:50:06",
"province": "广东省",
"city": "深圳市",
"district": "龙华区",
"carstatus": 4,
"weight": 1.0,
"weightAd": 38000
}, {
"tName": null,
"id": "424534860896534528",
"carid": "384373323083153408",
"deptid": "1",
"deptname": "总公司",
"msgid": 512,
"seq": 55,
"lng": 114.023233,
"lat": 22.739148,
"altitude": "0",
"speed": "0",
"direction": "0",
"mileage": 0.0,
"summileage": null,
"gpstime": "180317114956",
"gpsflag": 1,
"createtime": "2018-03-17 11:49:56",
"province": "广东省",
"city": "深圳市",
"district": "龙华区",
"carstatus": 4,
"weight": 1.0,
"weightAd": 38000
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| carstatus | 车辆状态 | int | |
| deptname | 组织机构名称 | string | |
| lng | 经度 | double | |
| lat | 纬度 | double | |
| altitude | 高度 | double | |
| speed | 速度 | string | Km/h |
| direction | 方向 | string | |
| mileage | 平台里程 | double | Km |
| summileage | 总里程 | double | km |
| gpstime | Gps时间 | string | |
| gpsflag | gps是否有效 | int | 0为无效,1为有效,2为上次信号有效时的位置 |
| createtime | 更新时间 | string | |
| province | 省 | string | |
| city | 市 | string | |
| district | 县 | string | |
| weight | 载重值 | double | |
| weightAd | 载重ad | int |
查询设备历史录像列表。使用注意该http请求历史列表的时候，时间不宜过长，如果列表过多，HTTP请求可能会超时。一般不要超过6个小时的时间。如果查询时间比较长，建议分段进行查询，然后对结果进行去重处理。
http://www.liveoss.com:8088/cmsapi/queryTerminalFileList
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 |
| id | 通道id | String | Y | 1 通道一 2 通道二 3 通道三 4 通道四 |
| vedioType | 数据类型 | int | Y | 0：音视频 1视频 2 双向对讲 3 监听 4 中心广播 5 透传 |
| streamType | 码流类型 | int | Y | 0:主码流 1：子码流 |
| memoryType | 存储类型 | int | Y | 0：所有存储器 1：主存储器 2：灾备服务器 |
| startTime | 开始时间 | String | Y | 如：2018-03-17 11:49:51 |
| endTime | 结束时间 | String | Y | |
| size | 文件大小 | String |
JSON参数：
{
"endTime": "2018-10-17 11:50:21",
"id": "1",
"memoryType": 0,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-08-17 11:49:51",
"streamType": 1,
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin",
"vedioType": 0
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"a63": 0,
"a61": 0,
"a62": 0,
"a60": 0,
"a20": 0,
"endTime": "180926180248",
"startTime": "180926180243",
"a16": 0,
"a17": 0,
"a14": 0,
"a15": 0,
"a12": 0,
"a13": 0,
"a10": 0,
"a11": 0,
"a59": 0,
"a58": 0,
"a57": 0,
"a56": 0,
"a55": 0,
"a18": 0,
"a54": 0,
"a19": 0,
"logicChannel": 1,
"memoryType": 1,
"a31": 0,
"a30": 0,
"size": 0,
"a25": 0,
"a26": 0,
"a27": 0,
"a28": 0,
"a21": 0,
"a22": 0,
"a23": 0,
"a24": 0,
"streamType": 1,
"a29": 0,
"a41": 0,
"a42": 0,
"a0": 0,
"a40": 0,
"mediaType": 2,
"a9": 0,
"a1": 0,
"a35": 0,
"a2": 0,
"a34": 0,
"a3": 0,
"a33": 0,
"a32": 0,
"a4": 0,
"a39": 0,
"a5": 0,
"a6": 0,
"a38": 0,
"a7": 0,
"a37": 0,
"a8": 0,
"a36": 0,
"a50": 0,
"a51": 0,
"a52": 0,
"a53": 0,
"a44": 0,
"a43": 0,
"a46": 0,
"a45": 0,
"a48": 0,
"a47": 0,
"a49": 0
}, {
"a63": 0,
"a61": 0,
"a62": 0,
"a60": 0,
"a20": 0,
"endTime": "180926182032",
"startTime": "180926182031",
"a16": 0,
"a17": 0,
"a14": 0,
"a15": 0,
"a12": 0,
"a13": 0,
"a10": 0,
"a11": 0,
"a59": 0,
"a58": 0,
"a57": 0,
"a56": 0,
"a55": 0,
"a18": 0,
"a54": 0,
"a19": 0,
"logicChannel": 1,
"memoryType": 1,
"a31": 0,
"a30": 0,
"size": 0,
"a25": 0,
"a26": 0,
"a27": 0,
"a28": 0,
"a21": 0,
"a22": 0,
"a23": 0,
"a24": 0,
"streamType": 1,
"a29": 0,
"a41": 0,
"a42": 0,
"a0": 0,
"a40": 0,
"mediaType": 2,
"a9": 0,
"a1": 0,
"a35": 0,
"a2": 0,
"a34": 0,
"a3": 0,
"a33": 0,
"a32": 0,
"a4": 0,
"a39": 0,
"a5": 0,
"a6": 0,
"a38": 0,
"a7": 0,
"a37": 0,
"a8": 0,
"a36": 0,
"a50": 0,
"a51": 0,
"a52": 0,
"a53": 0,
"a44": 0,
"a43": 0,
"a46": 0,
"a45": 0,
"a48": 0,
"a47": 0,
"a49": 0
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | List集合 |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| logicChannel | 通道号 | String | 从本位置开始为一个资源列表的开始 |
| startTime | 车牌号 | String | YYMMDDHHMMSS |
| endTime | 车辆状态 | int | YYMMDDHHMMSS |
| a0…a63 | 视频报警状态 | 见1078协议， 0表示没有 | |
| mediaType | 数据类型 | 0：音视频 1：音频 2：视频 3视频或音视频 | |
| streamType | 码流类型 | 0：所有码流 1：主码流 2 子码流 | |
| memoryType | 存储类型 | 0：所有存储器 1：主存储器 2：灾备服务器 |
远程录像回放。
http://www.liveoss.com:8088/cmsapi/playbackAppoint
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 |
| id | 通道id | String | Y | 1 通道一 2 通道二 3 通道三 4 通道四 |
| vedioType | 数据类型 | int | Y | 0：音视频 1视频 2 双向对讲3 监听 4 中心广播 5 透传 |
| streamType | 码流类型 | int | Y | 0:主码流 1：子码流 |
| memoryType | 存储类型 | int | Y | 0：所有存储器 1：主存储器 2：灾备服务器 |
| startTime | 开始时间 | String | 是 | 如：2018-03-17 11:49:51 |
| endTime | 结束时间 | String | 是 |
JSON参数：
{
"endTime": "2018-10-17 11:50:21",
"id": "1",
"memoryType": 0,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-10-17 11:49:51",
"streamType": 1,
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin",
"vedioType": 0
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"streamip": "120.76.235.109",
"streamport": "9600",
"url": "rtmp://120.76.235.109:10077/live/15814403512_channel_1_playback"
“ws":"ws://car-eye.cn:4025/ws?port=10077&app=live&stream=13751093 611_channel_1"
"http"：
"http://car-eye.cn:4025/flv?port=10077&app=live&stream=13751093611_cha nnel_1"
"https"：
"https://car-eye.cn:4025/flv?port=10077&app=live&stream=13751093611_ch a nnel_1"
"wss"：
"wss://car-eye.cn:4025/wss?port=10077&app=live&stream=13751093611_ch a nnel_1"
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData:
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| streamip | 流媒体ip | string | |
| streamport | 流媒体端口 | string | |
| url | 播放地址 | string | Rtmp 播放地址 |
| http | 播放地址 | string | http-flv 播放地址 |
| ws | 播放地址 | string | Ws-flv 播放地址 |
| https | 播放地址 | string | https-flv 播放地址 |
| wss | 播放地址 | string | Wss-flv 播放地址 |
远程录像回放控制。
http://www.liveoss.com:8088/cmsapi/controlBackAppoint
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 |
| id | 通道id | String | Y | 1 通道一 2 通道二 3 通道三 4 通道四 |
| playBackType | 播放速度 | Int | N | 默认0 0：开始回放1：暂停回放2：结束回放3：快速回放4：关键帧快速回放5：拖动回放6：关键帧播放 |
| playBackRatio | 快进或快退倍数 | Int | N | 0：无效 1：1倍 2:2倍 3:4倍 4:8倍 5:16倍 |
| fastPoistion | 快速拖动位置 | N | 格式yyyy-mm-dd hh:mm:ss |
JSON参数：
{
"fastPoistion": "2018-10-17 11:50:21",
"id": "1",
"playBackRatio": 4,
"playBackType": 3,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
文本信息下发
http://www.liveoss.com:8088/cmsapi/textInfo
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 可以是多个，以','分割 |
| emergency | 类型 | String | Y | 1：紧急 |
| lcd | 终端显示器 | String | Y | 0，不显示 1：显示 |
| tts | 终端TTS | int | Y | 0：不播读1：播读 |
| adv | 广告屏 | int | Y | 0，不显示 1：显示 |
| action | 动作 | int | Y | 0：中心导航信息，1：CAN 故障码信息 |
| content | 文本信息 | String | Y | |
| time | 信息显示时长 | int | Y | 单位：分钟 |
{
"action": 0,
"adv": 0,
"content": "ok",
"emergency": 1,
"lcd": 1,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"time": 1,
"tradeno": "20180908180001",
"tts": 1,
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": "1"
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 下发状态 | string | 1成功 2失败 |
根据条件文本信息下发记录。
http://www.liveoss.com:8088/cmsapi/textInfoRecord
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 终端号 | String | 是 | |
| startTime | 开始时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| currentPage | 当前页数 | Int | 是 | |
| everyPage | 每页条数 | Int | 是 |
JSON参数：
{
"currentPage": 1,
"emergency": 0,
"everyPage": 10,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-11-22 14:22:58",
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 1,
"data": [{
"id": "987362806787604480",
"terminalId": "904704994765307904",
"eventcode": 8,
"emergency": 0,
"downMessage": "3434343",
"data": "{\"msgid\":33536,\"subpacket\":0,\"encryption\":0,\"bodysize\":0,\"terminal\":\"13751093611\",\"seq\":5368,\"emergency\":0,\"lcd\":0,\"tts\":1,\"adv\":0,\"action\":0,\"textseq\":1,\"time\":1,\"content\":\"3434343\"}",
"seq": 5368,
"result": 1,
"isDelete": 0,
"createDate": "2022-06-17 14:27:17",
"modifyDate": "2022-06-17 14:27:18",
"modifyUser": "CarManageServer"
}]
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 |
| data | terminal_id | 设备id | String | 设备表id |
| emergency | 紧急类型 | String | 0不紧急 1：紧急 | |
| downMessage | 文本信息 | String | ||
| createDate | 下发时间 | data | Unix时间戳 | |
| data | 下发json协议 | String | ||
| seq | 消息序列号 | int | ||
| result | 下发状态 | int | 0初始下发中 1成功 ，2 失败 | |
| count | 总记录数 | int | ||
文件上传指令下发
http://www.liveoss.com:8088/cmsapi/fileUpload
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 可以是多个，以','分割 |
| logicChannel | 逻辑通道号 | int | Y | |
| startTime | 开始时间 | String | Y | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | Y | yyyy-MM-dd HH:mm:ss |
| a0...a63 | 报警标志 | int | N | 64个json属性,0或者1,1报警 |
| mediaType | 音视频资源类型 | int | Y | 0：音视频 1：音频 2：视频 3 音频或者视频 |
| streamType | 码流类型 | int | Y | 0：主码流 1：子码流 |
| recordPosition | 存储位置 | int | Y | 0：主存储器或灾备存储器 1：主存储器 2：灾备存储器 |
| taskOp | 执行任务条件 | int | Y | 1：wifi可以下载 2：lan可以下载 3: 4G 状态可以下载 支持多选（取值如下：1,2,3,12,13,23,123） |
{
"a0": 0,
"a1": 0,
"a10": 1,
"a11": 0,
"a12": 1,
"a13": 0,
"a14": 0,
"a15": 0,
"a16": 0,
"a17": 0,
"a18": 0,
"a19": 0,
"a2": 0,
"a20": 0,
"a21": 0,
"a22": 0,
"a23": 0,
"a24": 0,
"a25": 0,
"a26": 0,
"a27": 0,
"a28": 0,
"a29": 0,
"a3": 0,
"a30": 0,
"a31": 0,
"a32": 0,
"a33": 0,
"a34": 0,
"a35": 0,
"a36": 0,
"a37": 0,
"a38": 0,
"a39": 0,
"a4": 0,
"a40": 0,
"a41": 0,
"a42": 0,
"a43": 0,
"a44": 0,
"a45": 0,
"a46": 0,
"a47": 0,
"a48": 0,
"a49": 0,
"a5": 0,
"a50": 0,
"a51": 0,
"a52": 0,
"a53": 0,
"a54": 0,
"a55": 0,
"a56": 0,
"a57": 0,
"a58": 0,
"a59": 0,
"a6": 0,
"a60": 0,
"a61": 0,
"a62": 0,
"a63": 0,
"a7": 0,
"a8": 0,
"a9": 0,
"control": 0,
"endTime": "2018-12-22 14:22:58",
"logicChannel": 1,
"meidiaType": 0,
"memoryType": 0,
"recordPosition": 0,
"seqNumber": 0,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"size": 0,
"startTime": "2018-11-22 14:22:58",
"streamType": 0,
"taskOp": 0,
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": "10001"
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 上传流水号 | string | 用于文件上传控制 |
文件上传指令下发
http://www.liveoss.com:8088/cmsapi/fileUploadControl
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | Y | 设备号 可以是多个，以','分割 |
| control | 逻辑通道号 | int | Y | 0：暂停 1：继续 2：取消 |
| seqNumber | 上传流水号 | int | Y | 用于文件上传控制 |
{
"control": 0,
"seqNumber": 10001,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
文件上传记录查询，上传成功的文件可以采用ftp进行下载。
http://www.liveoss.com:8088/cmsapi/fileRecord
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 终端号 | String | 是 | |
| logicChannel | 逻辑通道号 | int | 否 | |
| seqNumber | 上传流水号 | string | 否 | |
| result | 文件状态 | Int | 否 | 文件状态：0上传中,1上传成功 2上传失败 |
| a0...a63 | 报警标志 | int | 否 | 64个json属性,0或者1,1报警 |
| mediaType | 音视频资源类型 | int | 否 | 0：音视频 1：音频 2：视频 3 音频或者视频 |
| streamType | 码流类型 | int | 否 | 0：主码流 1：子码流 |
| recordPosition | 存储位置 | int | 否 | 0：主存储器或灾备存储器 1：主存储器 2：灾备存储器 |
| taskOp | 执行任务条件 | int | 否 | 1：wifi可以下载 2：lan可以下载 3: 4G 状态可以下载 支持多选（取值如下：1,2,3,12,13,23,123） |
| startTime | 开始时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| currentPage | 当前页数 | Int | 是 | |
| everyPage | 每页条数 | Int | 是 |
{
"currentPage": 1,
"everyPage": 10,
"logicChannel": 1,
"mediaType": 0,
"recordPosition": 1,
"result": 1,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-12-11 14:22:18",
"streamType": 0,
"taskOp": 3,
"terminal": "13751093611",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 1,
"data": [{
"id": "987313392568107008",
"deptid": "1",
"userid": "430130351050981376",
"terminal": "13751093611",
"terminalId": "904704994765307904",
"logicChannel": 1,
"startTime": "2022-06-17 10:52:26",
"endTime": "2022-06-17 11:07:26",
"mediaType": 0,
"streamType": 1,
"recordPosition": "1",
"taskOp": 123,
"alarmType": 0,
"seqNumber": 15323,
"result": 1,
"filePath": "/record_file/20220617/13751093611/1/15323/I20220617-105226P3N1PD.avi",
"fileSize": "118.26",
"isDelete": 0,
"createDate": "2022-06-17 11:10:56",
"createUser": "admin",
"modifyDate": "2022-06-17 11:18:47",
"modifyUser": "CarManageServer",
"uploadFileSize": "118.26"
}]
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 上传流水号 | string | 用于文件上传控制 |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 |
| data | terminal | 设备号 | String | 设备号 |
| logicChannel | 逻辑通道号 | int | ||
| startTime | 开始时间 | String | yyyy-MM-dd HH:mm:ss | |
| endTime | 结束时间 | String | yyyy-MM-dd HH:mm:ss | |
| mediaType | 音视频资源类型 | int | 0：音视频 1：音频 2：视频 3 音频或者视频 | |
| streamType | 码流类型 | int | 0：主码流 1：子码流 | |
| recordPosition | 存储位置 | int | 0：主存储器或灾备存储器 1：主存储器 2：灾备存储器 | |
| taskOp | 执行任务条件 | int | 1：wifi可以下载 2：lan可以下载 3: 4G 状态可以下载 支持多选（取值如下：1,2,3,12,13,23,123） | |
| a0...a63 | 报警标志 | int | 0正常 1报警 | |
| seqNumber | 流水号 | int | ||
| filePath | 文件路径 | String | ftp觉得路径，包括文件名，比如：aa/bb/cc.mp4 | |
| fileSize | 文件大小 | String | 文件大小，单位：M | |
| result | 文件状态 | int | 0上传中,1上传成功 2上传失败败 | |
| count | 总记录数 | int | ||
获取文件服务器参数，用于ftp文件下载。
http://www.liveoss.com:8088/cmsapi/getServerInfo
无
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"id": "1",
"ftpIp": "39.108.246.45",
"ftpPort": 1721,
"ftpUsername": "ftp",
"ftpPassword": "ftp#20181130",
"alarmFileDir": "/alarm",
"recoderFileDir": "/record_file",
"recoderUploadDir": "/record_upload",
"bk1": null,
"bk2": null,
"isDelete": 0,
"createDate": 1543644277000,
"createUser": "admin",
"modifyDate": 1543644282000,
"modifyUser": "admin"
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | object |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 | |
| ftpIp | ftp ip | string | ||
| ftpPort | ftp 端口号 | int | ||
| ftpUsername | ftp 用户名 | string | ||
| ftpPassword | ftp 密码 | string | ||
| recoderFileDir | 录制文件存放目录 | |||
跟据设备号获取设备状态。
http://www.liveoss.com:8088/cmsapi/getTerminalStatus
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 否 | 设备号 可以是多个，以','分割。 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "13751093611,15814403512",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": "13751093611",
"status": 4
}, {
"terminal": "15814403512",
"status": 2
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 备注 | 数据类型 |
| terminal | 设备号 | String | |
| status | 车辆状态 | 状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 | int |
对设备进行终端控制，发送控制指令。
http://www.liveoss.com:8088/cmsapi/terminalControl
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 | 设备号 |
| type | 控制类型 | Int | 是 | 3终端关机，4终端复位，5恢复出厂设置，6关闭数据通信，7关闭所有无线通信 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"type": 3,
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData":null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
对设备进行位置跟踪，发送位置跟踪指令。
http://www.liveoss.com:8088/cmsapi/positionTrack
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 | 设备号 |
| inv | 时间间隔 | Int | 是 | 单位为秒(s),0则停止跟踪,停止跟踪无需带后继字段 |
| expire | 位置跟踪有效期 | 单位为秒(S) |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"inv": 5,
"expire": 60,
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData":null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
获取指定机构下所有的车辆列表。
http://www.liveoss.com:8088/cmsapi/listCarInfoByDeptId
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| deptid | 机构id | String | 是 | 机构ID |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"tradeno": "20180908180001",
"deptid": "430130351025815552",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": "15211110012",
"nodeId": "535959611203780608",
"parentId": "430130351025815552",
"nodeName": "粤B05052",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "15211110000",
"nodeId": "535957158504824832",
"parentId": "430130351025815552",
"nodeName": "粤B05000",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "18092216026",
"nodeId": "531848445590372352",
"parentId": "430130351025815552",
"nodeName": "陕A66666",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "18620303263",
"nodeId": "526446900593950720",
"parentId": "430130351025815552",
"nodeName": "粤B43215",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "15627916631",
"nodeId": "524248379627274240",
"parentId": "430130351025815552",
"nodeName": "粤B66666",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "15720804002",
"nodeId": "523529278466424832",
"parentId": "430130351025815552",
"nodeName": "粤B33333",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "13510671871",
"nodeId": "523099658298458112",
"parentId": "430130351025815552",
"nodeName": "粤B09544",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "13662350703",
"nodeId": "512668477388095488",
"parentId": "430130351025815552",
"nodeName": "粤B76542",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "13751093611",
"nodeId": "510457517344686080",
"parentId": "430130351025815552",
"nodeName": "上B12346",
"nodetype": 2,
"carstatus": 4,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 8,
"parent": false
}, {
"terminal": "13100010001",
"nodeId": "503704583974027264",
"parentId": "430130351025815552",
"nodeName": "粤B00001",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 3,
"parent": false
}, {
"terminal": "13510671870",
"nodeId": "494260781639139328",
"parentId": "430130351025815552",
"nodeName": "粤B44444",
"nodetype": 2,
"carstatus": 2,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}, {
"terminal": "15814403512",
"nodeId": "430130351176810496",
"parentId": "430130351025815552",
"nodeName": "粤B03512",
"nodetype": 2,
"carstatus": 1,
"total": null,
"caroffline": null,
"longoffline": null,
"channeltotals": 4,
"parent": false
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 数据列表 | List | 见下表 |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| nodeId | 节点id | string | 车辆id |
| parentId | 父级节点 | string | 机构id |
| nodeName | 节点名称 | string | 车牌号 |
| carstatus | 车辆状态 | int | 节点是车辆才有值 车辆状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 |
| terminal | 终端号 | string | |
| channeltotals | 摄像头个数 | int |
对设备进行查询终端属性，发送查询指令。
http://www.liveoss.com:8088/cmsapi/queryTerminalParam
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 | 设备号 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "13751093611",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"firmwareno": "T18071922-V809201",
"hardwareno": "JH5S-720P-2051",
"msgid": 263,
"oem": "71603",
"iccid": "0000000000000000000",
"termainalid": "00000",
"cnssproperty": "00000011",
"type": "0000000000000111",
"termainaltype": "JH5S-L",
"firmwarelen": 17,
"terminal": "13751093611",
"encryption": 0,
"bodysize": 79,
"hardwarelen": 14,
"seq": 877,
"subpacket": 0,
"comproperty": "11111111"
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData格式如下,可以参照协议文档：
| JSON属性 | 字段 | 数据类型 | 说明 |
| type | 终端类型 | string | bit0指的是最后一位，高位在前。 bit0，0：不适用客运车辆，1：适用客运车辆； bit1，0：不适用危险品车辆，1：适用危险品车辆； bit2，0：不适用普通货运车辆，1：适用普通货运车辆； bit3，0：不适用出租车辆，1：适用出租车辆； bit6，0：不支持硬盘录像，1：支持硬盘录像； bit7，0：一体机，1：分体机。 |
| oem | 制造商 id | string | 终端制造商编码。 |
| termainaltype | 终端型号 | string | |
| termainalid | 终端 id | string | |
| iccid | 终端 sim 卡 iccid | string | 终端 sim 卡 iccid 号 |
| hardwarelen | 终端硬件版本号长度 | int | |
| hardwareno | 终端硬件版本号 | string | |
| firmwarelen | 终端固件版本号长度 | int | |
| firmwareno | 终端固件版本号 | string | |
| cnssproperty | gnss 模块属性 | string | bit0指的是最后一位，高位在前。 bit0，0：不支持 gps 定位， 1：支持 gps 定位； bit1，0：不支持北斗定位， 1：支持北斗定位； bit2，0：不支持 glonass 定位， 1：支持 glonass 定位； bit3，0：不支持 galileo 定位， 1：支持 galileo 定位。 |
| comproperty | 通信模块属性 | string | bit0，0：不支持GPRS通信， 1：支持GPRS通信； bit1，0：不支持CDMA通信， 1：支持CDMA通信； bit2，0：不支持TD-SCDMA通信， 1：支持TD-SCDMA通信； bit3，0：不支持WCDMA通信， 1：支持WCDMA通信； bit4，0：不支持CDMA2000通信， 1：支持CDMA2000通信。 bit5，0：不支持TD-LTE通信， 1：支持TD-LTE通信； bit7，0：不支持其他通信方式， 1：支持其他通信方式。 |
跟据设备号获取设备GPS状态。
http://www.liveoss.com:8088/cmsapi/getAlarmStatus
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 | 设备号 可以是多个，以','分割。 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "529040329357,13300000001",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"terminal": "529040329357",
"alarmStatus": "[12,19,20,42,44,45]",
"alarmDesc": "摄像头故障,当天累计驾驶超时,超时停车,通道1视频丢失报警,通道3视频丢失报警,通道4视频丢失报警",
"alarmStatusPlat": "[]",
"lng": 113.853008,
"lat": 22.586188,
"altitude": 41,
"time": "2022-08-05 19:45:01"
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData格式如下,可以参照协议文档：
| JSON属性 | 字段 | 数据类型 | 说明 |
| terminal | 终端号 | string | |
| alarmStatus | 设备报警状态 | string | Json数组 |
| alarmStatusPlat | 平台报警状态 | string | Json数组 |
| alarmDesc | 报警描述 | string | |
| lng | 经度 | double | |
| lat | 纬度 | double | |
| time | 时间 | string | |
| altitude | 高程 | int |
根据条件获取报警信息列表。
http://www.liveoss.com:8088/cmsapi/queryAlarmList
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 终端号 | String | 是 | 可以是多个，以','分割。 |
| startTime | 开始时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 否 | yyyy-MM-dd HH:mm:ss |
| currentPage | 当前页数 | Int | 是 | . |
| everyPage | 每页条数 | Int | 是 |
JSON参数：
{
"currentPage": 1,
"everyPage": 10,
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2019-05-03 00:13:42",
"terminal": "13751093611",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 201,
"data": [
{
"alarmDesc": "通道5视频丢失报警",
"id": "740946235963211776",
"alarmNumber": 46,
"alarmSource": 0,
"createDate": "2022-06-07 14:55:49",
"isDelete": 0,
"isHandle": "0",
"modifyDate": "2022-06-07 14:55:49",
"startAlarmList": "[46,47,48,49]",
"startExtraInfo": "{20:{\"v1\":\"[0]\"},21:{\"v1\":\"[4,5,6,7]\"},37:{\"v1\":0},43:{\"v1\":0},48:{\"v1\":27},49:{\"v1\":15},239:{\"v1\":\"00000000000000000000000003\"}}",
"startLat": 22.62975,
"startLon": 114.071448,
"startSpeed": 0,
"startStatusList": "[0,1,6,7,18,19]",
"startTime": "2022-06-07 14:55:48",
"startTimestamp": "1654584948000",
"terminalId": "981609257139044352",
"count": 0
}
]
}
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 | |
| data | id | id | String | ||
| alarmDuration | 报警时长 | String | |||
| alarmInfo | 报警信息 | String | |||
| alarmNumber | 报警编号 | String | |||
| alarmLevel | 报警级别 | data | |||
| alarmSource | String | ||||
| endAlarmList | 报警结束报警列表 | ||||
| endExtraInfo | 报警结束附加信息 | ||||
| endLon | 报警结束经度 | ||||
| endLat | 报警结束纬度 | ||||
| endLocation | 报警结束位置 | int | |||
| endSpeed | 报警结束时速度 | ||||
| endStatusList | 报警结束时列表 | ||||
| endTime | 报警结束时间 | Unix时间戳 | |||
| handleBy | 处理人ID | ||||
| handleContent | 处理内容 | ||||
| handleTime | 处理时间 | ||||
| isHandle | 是否处理 | 0:未处理,1:已处理 | |||
| startAlarmList | 报警开始时列表 | ||||
| startExtraInfo | 报警开始附加信息 | ||||
| startLat | 报警开始纬度 | ||||
| startLon | 报警开始经度 | ||||
| startLocation | 报警开始位置 | ||||
| startSpeed | 报警开始速度 | ||||
| startStatusList | 报警开始状态列表 | ||||
| startTime | 报警开始时间 | ||||
| startTimestamp | 报警开始时间戳 | ||||
| createDate | 报警时间 | Unix时间戳 | |||
| terminalId | 报警设备ID | ||||
| alarmDesc | 报警名称 | ||||
| count | 总记录数 | int | |||
跟据设备号获取设备GPS状态。
http://www.liveoss.com:8088/cmsapi/getGpsStatus
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 否 | 设备号 可以是多个，以','分割。 |
JSON参数：
{
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "13751093611",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [{
"id": null,
"terminal": "13751093611",
"carnumber": "上B12346",
"carstatus": 4,
"lng": 113.86473,
"lat": 22.578723,
"acc": 1,
"altitude": "7",
"speed": "0.0",
"direction": "0",
"gpstime": "190505174926",
"gpsflag": 1,
"mileage": null,
"summileage": "0.0",
"alarmStatus": "[]",
"alarmStatusPlat": "[6,7]",
"alarmDesc": "GNSS天线未接或被剪断报警,GNSS天线短路",
"carState": "{\"s0\":1,\"s1\":1,\"s2\":0,\"s3\":0,\"s5\":0,\"s6\":0,\"s9\":0,\"s18\":1}",
"weight": 1.0,
"weightAd": 38000
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 备注 | 数据类型 |
| terminal | 设备号 | String | |
| carnumber | 产品号 | String | |
| carstatus | 车辆状态 | 状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 | int |
| lng | 经度 | double | |
| lat | 纬度 | double | |
| altitude | 高度 | int | |
| speed | 速度 | int | |
| direction | 方向 | int | |
| mileage | 里程 | double | |
| summileage | 总里程 | double | |
| gpstime | gps时间 | date | |
| gpsflag | gps是否有效 | int | |
| acc | acc状态 | int | |
| alarmStatus | 设备报警状态 | string | Json数组 |
| alarmStatusPlat | 平台报警状态 | string | Json数组 |
| alarmDesc | 报警描述 | string | |
| carState | 状态 | Json,包括s0到s31,对应标志无值就没有对应的key | 对应808的状态 |
| weight | 载重值 | double | |
| weightAd | 载重ad | int |
对设备进行报警解除。
http://www.liveoss.com:8088/cmsapi/alarmRemove
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 是 | |
| alarmNumber | 报警编号 | String | 是 |
JSON参数：
{
"sign": "AF40F704A813C81AFC2F30B98E826F5B",
"terminal": "13751093611",
"alarmNumber": "28",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": null
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
-
- 获取设备载重事件
获取设备载重事件信息。
http://www.liveoss.com:8088/cmsapi/eventsAllList
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 设备号 | String | 否 | 设备号和车牌号不能全部为空 |
| carnumber | 车牌号 | String | 否 | |
| startTime | 开始时间 | String | 是 | 如：2022-01-24 11:49:51 |
| endTime | 结束时间 | String | 是 |
JSON参数：
{
"endTime": "2018-03-17 11:50:21",
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"startTime": "2018-03-17 11:49:51",
"terminal": "13700000007",
"tradeno": "20180908180001",
"username": "admin"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [
{
"carnumber": "测LF0750",
"eventType": 1,
"accStatus": 1,
"startWeight": 3.973,
"weightChange": 4,
"startTime": "2022-01-24 07:17:32",
"startLng": 121.068704,
"startLat": 31.207694,
"startSpeed": 0,
"startAd": 35203,
"endWeight": 0,
"endTime": "2022-01-24 07:24:02",
"endLng": 121.069776,
"endLat": 31.207124,
"endSpeed": 23.9,
"deptname": "载重测试"
}]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| eventType | 载重事件 | int | 0装货1卸货 |
| carnumber | 车牌号 | string | |
| accStatus | 引擎状态 | int | |
| startWeight | 开始载重 | double | 单位吨 |
| weightChange | 装卸量 | double | 单位吨 |
| startTime | 开始时间 | string | |
| startLng | 开始经度 | double | |
| startLat | 开始纬度 | double | |
| startSpeed | 开始速度 | double | |
| startAd | 开始ad值 | int | |
| endWeight | 结束载重 | double | 单位吨 |
| endTime | 结束时间 | String | |
| endLng | 结束经度 | double | km |
| endLat | 结束纬度 | double | |
| deptname | 部门 | string |
人脸识别记录导出。
http://www.liveoss.com:8088/cmsapi/driverRecognizeRecord
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| startTime | 开始时间 | String | 是 | |
| endTime | 结束时间 | String | 是 | |
| carnumberList | 车牌号 | json数组 | 是 | ["测B01234"] |
JSON参数：
{
"startTime": "2022-06-06 14:00:07",
"sign": "B3002A3C6A68EF5287030566C611190D",
"tradeno": "20180908180001",
"username": "admin",
"carnumberList": ["测B01234"],
"endTime": "2022-06-07 14:00:07"
}
{
"errCode": 0,
"resultMsg": "成功",
"resultData": [
{
"id": "983732098563178496",
"terminalId": "981609257139044352",
"result": 1,
"samePrecision": 0.5,
"sameRate": 0,
"compareType": 2,
"format": 0,
"faceId": "914912638213947392",
"lng": 114.071416,
"lat": 22.6296,
"photo": "/api/upload/CarDep/20220516001/pic/20220516001_220607140009.JPEG",
"size": 14676,
"speed": 0,
"carnumber": "测B01234",
"drivername": "2222",
"deptname": "GPS设备",
"altitude": 105,
"time": "2022-06-07 14:00:07"
}
]
}
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| result | 比对结果 | BYTE 0：匹配成功； 1：匹配失败； 2：超时； 3：没有启用该功能； 4：连接异常； 5：无指定人脸图片 6：无人脸库 | |
| samePrecision | 比对相似度阈值 | ||
| sameRate | 比对相似度 | ||
| compareType | 0-插卡比对；1-巡检比对；2-点火比对；3-离开返回比对 | ||
| faceId | 人脸id | ||
| lng | 经度 | ||
| lat | 纬度 | ||
| time | 比对时间 | ||
| photo | 抓拍的图片 | ||
| format | 0：JPEG | ||
| size | 图片大小 | ||
| speed | 速度Km/h | ||
| altitude | 高度 |
-
- 摄像头立即拍摄命令
- 功能介绍
- 摄像头立即拍摄命令
拍照
-
-
- 接口地址
-
http://www.liveoss.com:8088/cmsapi/sendCameraCommand
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| terminal | 通信sim卡 | String | 是 | |
| channel | 通道号 | String | 是 | |
| cmd | 拍摄命令 | String | 是 | 0表示停止拍摄；0xFFFF表示录像；其他表示拍照张数 |
| inv | 拍照间隔 | String | 是 | 拍照间隔多少秒，0 表示按最小间隔拍照或一直拍照 |
| save | 保存标志 | String | 是 | 保持标志 1：保存；0：实时上传 |
| screen | 分辨率 | String | 是 | 0:最低分辨率,1:320x240,2:640x480,3:800x600,4,1024x768,5:176x144(qcif),6:352x288(cif),7:704x288(half d1),8:704x576(d1),255:最高分辨率" |
| quality | 视频质量 | String | 是 | 1-10，1 代表质量损失最小，10 表示压缩比最大 |
| bright | 亮度 | String | 是 | 0-255 |
| contrast | 对比度 | String | 是 | 0-127 |
| saturation | 饱和度 | String | 是 | 0-127 |
| chroma | 色度 | String | 是 | 0-255 |
-
-
- 请求示例
-
JSON参数：
{
"terminal": "13751093611",
"channel": "1",
"cmd": "1",
"inv": "1",
"save": "0",
"screen": "1",
"quality": "1",
"bright": "1",
"contrast": "1",
"saturation": "1",
"chroma": "1",
"sign": "62B8B8B967897FFCF7D61B16202471FC",
"terminal": "15814403512",
"tradeno": "20180908180001"
}
-
-
- 返回值
-
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"result": 1,
"path": "http://liveoss.com/api/upload/CarDep/13751093611/pic/13751093611_1_32322_221215140919.jpeg"
}
}
-
-
- 返回值说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| result | 结果 | Int | 0：成功； 1失败 |
| path | 地址 | String | 图片地址 |
-
- websocket报警信息
- 功能介绍
- websocket报警信息
报警信息,每分钟需要发送心跳维持链接，心跳内容为:HeartBeat
-
-
- 接口地址
-
ws://liveoss.com:8088/cmsapi/webSocket
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| admin | 用户名 | String | 是 | |
| password | 密码 | String | 是 | md5加密 |
| tradeno | 流水号 | String | 是 | 客户自己定，可以取时间戳 |
| sign | 签名 | String | 是 | 详见开头签名规则 |
-
-
- 请求示例
-
ws://liveoss.com:8088/cmsapi/webSocket?password=E10ADC3949BA59ABBE56E057F20F883E&username=test&tradeno=20180908180001&sign=9D6552A9EB90F3B1925B2516263C2AA7
开始报警推送消息定义 {
"acc": 0,
"alarmDesc": "紧急报警",
"alarmJsonMsg": "{\"startLat\":21.2970930654259,\"alarmNumber\":1,\"terminalId\":\"8 64104856200282112\",\"startLon\":104.5658878623906,\"startSpeed\":23. 6,\"alarmSource\":0,\"startAlarmList\":\"[1,2,4]\",\"startTime\":\"2 022-12-17 09:52:33\",
\"id\":\"810810775273734144\",\"isHandle\":0,\"createDate \":\"2022-12-17T09:52:32.961\"}",
"alarmname": "紧急报警",
"msgid": 2,
"terminal": "13800000001"
}
结束报警的消息推送
{
"acc": 0,
"alarmDesc": "紧急报警",
"alarmJsonMsg": "{\"startLat\":21.2970930654259,\"endLat\":21.2970930654259,\"alarmNumber\":1,\"terminalId\":\"864104856200282112\",\"startLon\":104.5658878623906,\"endLon\":104.5658878623906,\"startSpeed\":23.6,\"endSpeed\":23.6,\"alarmSource\":0,\"startAlarmList\":\"[1,2,4]\",\"startTime\":\"2022-12-17 09:52:33\",\"endTime\":\"2022-12-17 09:52:33\",\"id\":\"810810775273734144\",\"isHandle\":0,\"createDate\":\"2022-12-17T09:52:32.961\"}",
"alarmname": "紧急报警",
"msgid": 3,
"terminal": "13800000001"
}
-
-
- 消息体说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| alarmname | 报警名称 | String | |
| terminal | 通信sim卡 | String | |
| acc | Acc信号 | int | |
| alarmJsonMsg | 报警数据体 | String | 如下表描述 |
| alarmDesc | 报警的描述 | String | |
| carstatus | 车辆状态 | Int | 状态 1：长时间离线 2：离线 3：熄火 4：停车 5：行驶 6：报警 7：在线 8：未定位 |
| msgid | 消息类型 | int | 2:开始报警 3:结束报警 |
alarmJsonMsg数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| startLat | 开始纬度 | double | |
| startLon | 开始经度 | double | |
| startSpeed | 开始速度 | double | |
| startTime | 报警开始时间 | String | |
| alarmNumber | 报警编码 | int | 参考附件1说明 |
| endLat | 结束纬度 | double | |
| endlon | 结束经度 | double | |
| endSpeed | 结束速度 | double | |
| endTime | 结束时间 | String |
-
- 主动安全报警列表
- 功能介绍
- 主动安全报警列表
主动安全报警列表记录
-
-
- 接口地址
-
http://liveoss.com:8088/cmsapi/safetyAlarmList
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| startTime | 开始时间 | string | 是 | |
| endTime | 结束时间 | string | 是 | |
| alarmTypeBk | 报警分类 | string | 1:ADAS 2:DSM 3:TPMS 4:BSD | |
| alarmLevel | 报警级别 | int | 1:1级 2:2级 | |
| driverIds | 驾驶员id | string | 多个逗号分割 | |
| carnumbers | 车牌号码 | string | 多个逗号分割 | |
| speed | 速度 | double | 大于某个速度 |
-
-
- 请求示例
-
{
"password": "5C5E99F1E9ED4FD8E0476B270DEA2EF4",
"sign": "B3002A3C6A68EF5287030566C611190D",
"tradeno": "20180908180001",
"username": "admin",
"page":1,
"limit":10,
"startTime":"2023-05-19 00:00:00",
"endTime":"2023-05-19 23:59:59"
}
-
-
- 返回值说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 |
| data | id | 报警编号 | string | |
| deptname | 部门名称 | string | ||
| carnumber | 车牌号 | string | ||
| colorName | 车牌颜色 | string | ||
| showCount | 报警个数 | string | 示例:4/4 | |
| alarmLevelName | 报警等级 | string | ||
| minclassName | 报警类型 | string | ||
| startTime | 报警开始时间 | string | ||
| endTime | 报警结束时间 | string | ||
| startLat | 报警开始纬度 | double | ||
| endLat | 报警结束纬度 | double | ||
| startLon | 报警开始经度 | double | ||
| endLon | 报警结束经度 | double | ||
| strGPSstatus | 状态 | string | 示例:ACC打开，左转向关闭 | |
| count | 总记录数 | int | ||
-
- 主动安全报警详情
- 功能介绍
- 主动安全报警详情
苏标主动安全报警详情
-
-
- 接口地址
-
http://liveoss.com:8088/cmsapi/safetyAlarmDetail
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| id | 报警编号 | String | 是 |
-
-
- 请求示例
-
{
"password": "5C5E99F1E9ED4FD8E0476B270DEA2EF4",
"sign": "B3002A3C6A68EF5287030566C611190D",
"tradeno": "20180908180001",
"username": "admin",
"id":"866397655176052736"
}
-
-
- 消息体说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData | 上传流水号 | string | 用于文件上传控制 |
resultData数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| carDriverInfo | 司机信息 | string | |
| deviceAlarm | 报警信息 | string | |
| deviceAlarmList | 附件列表信息 | string | |
| alarmLevelName | 报警等级 | string | |
| minclassName | 报警类型 | string |
carDriverInfo数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| drivername | 司机名字 | string | |
| phone | 司机手机号码 | string |
deviceAlarm数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| deptname | 部门名称 | string | |
| carnumber | 车牌号 | string | |
| count | 附件个数 | Int | |
deviceAlarmList列表数据结构：
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| path | 附件地址 | string | |
| alarmDuration | 报警时长 | string |
-
- 里程
- 功能介绍
- 里程
根据条件获取里程
-
-
- 接口地址
-
http://www.liveoss.com:8088/cmsapi/mileage
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| deptid | 部门id | String | 否 | |
| startTime | 开始时间 | String | 是 | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 是 | yyyy-MM-dd HH:mm:ss |
| page | 当前页数 | Int | 否 | 默认1 |
| limit | 每页条数 | Int | 否 | 默认10 |
| allPage | 所有页 | Int | 否 | 1为查询所有 |
| carnumbers | 车牌号 | String | 否 | 多个逗号分隔 |
-
-
- 请求示例
-
JSON参数：
{
"sign": "4DD4B8B5F0E04E34DA7B7E157C68448A",
"tradeno": "20180908180001",
"username": "admin",
"startTime":"2023-07-01 00:00:00",
"endTime":"2023-07-01 23:59:59"
}
-
-
- 返回值
-
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 43,
"data": [
{
"carid": "1112788177803935744",
"deptname": "车辆管理平台",
"terminal": "13800000001",
"carnumber": "测A99999",
"startMileage": 0,
"endMileage": 0,
"startLng": 0,
"startLat": 0,
"endLng": 0,
"endLat": 0
},
{
"carid": "862769644820365312",
"deptname": "视频设备",
"terminal": "16808254792",
"carnumber": "粤B67888",
"startMileage": 0,
"endMileage": 0,
"startLng": 109.531784,
"startLat": 18.215836,
"endLng": 109.531784,
"endLat": 18.215836
}
]
}
}
-
-
- 返回值说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 | |
| data | carid | 车辆id | String | ||
| carnumber | 车牌号 | String | |||
| deptname | 部门名称 | double | |||
| terminal | 终端标识 | String | |||
| startMileage | 开始里程 | double | |||
| endMileage | 结束里程 | double | |||
| startLat | 开始纬度 | double | |||
| startLng | 开始经度 | double | |||
| endLat | 结束纬度 | double | |||
| endLng | 结束经度 | double | |||
| count | 总记录数 | int | |||
-
- 日油耗
- 功能介绍
- 日油耗
根据条件获取日油耗
-
-
- 接口地址
-
http://www.liveoss.com:8088/cmsapi/oilUseDay
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| deptid | 部门id | String | 否 | |
| startTime | 开始时间 | String | 是 | yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 是 | yyyy-MM-dd HH:mm:ss |
| page | 当前页数 | Int | 否 | 默认1 |
| limit | 每页条数 | Int | 否 | 默认10 |
| allPage | 所有页 | Int | 否 | 1为查询所有 |
| carnumbers | 车牌号 | String | 否 | 多个逗号分隔 |
-
-
- 请求示例
-
JSON参数：
{
"sign": "4DD4B8B5F0E04E34DA7B7E157C68448A",
"tradeno": "20180908180001",
"username": "admin",
"startTime":"2023-07-01 00:00:00",
"endTime":"2023-07-01 23:59:59"
}
-
-
- 返回值
-
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 1,
"data": [
{
"deptname": "视频设备",
"carnumber": "油B0003",
"carTypeName": "大型客车",
"terminal": "13610051256",
"runOilUse100km": 51.33,
"allOilUse100km": 65.56,
"workMileage": 86.21,
"idleMileage": 0,
"idleTime": 17671,
"idleOilUse": 12.27,
"oilUse": 56.52,
"oilPercentUse": 0,
"oilAdd": 103.8,
"oilLose": 0,
"oil": 245.52,
"workTime": 33048,
"oilUseHour": 6.16,
"startOil": 198.24,
"endOil": 245.52
}
]
}
}
-
-
- 返回值说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 | |
| data | day | 日期 | String | ||
| deptname | 部门名称 | String | |||
| carnumber | 车牌号 | String | |||
| runOilUse100km | 运行百公里油耗 | double | |||
| allOilUse100km | 综合百公里油耗 | double | |||
| workMileage | 工作里程 | double | |||
| idleMileage | 怠速里程 | double | |||
| idleTime | 怠速时间,单位秒 | int | |||
| idleOilUse | 怠速油耗 | double | |||
| oilUse | 油耗 | double | |||
| oilPercentUse | 油耗百分比 | double | |||
| oilAdd | 加油量 | double | |||
| oilLose | 漏油量 | double | |||
| oil | 最后油量 | double | |||
| workTime | 工作时长 | int | |||
| oilUseHour | 每小时油耗 | double | |||
| startOil | 开始油量 | double | |||
| endOil | 结束油量 | double | |||
| terminal | 终端标识 | string | |||
| count | 总记录数 | int | |||
-
- 月油耗
- 功能介绍
- 月油耗
根据条件获取月油耗
-
-
- 接口地址
-
http://www.liveoss.com:8088/cmsapi/oilUseMonth
-
-
- 私有参数
-
| 参数名 | 含义 | 格式 | 是否必填 | 说明 |
| deptid | 部门id | String | 否 | |
| startTime | 开始时间 | String | 是 | yyyy-MM-dd |
| endTime | 结束时间 | String | 是 | yyyy-MM-dd HH:mm:ss |
| page | 当前页数 | Int | 否 | 默认1 |
| limit | 每页条数 | Int | 否 | 默认10 |
| allPage | 所有页 | Int | 否 | 1为查询所有 |
| carnumbers | 车牌号 | String | 否 | 多个逗号分隔 |
-
-
- 请求示例
-
JSON参数：
{
"sign": "4DD4B8B5F0E04E34DA7B7E157C68448A",
"tradeno": "20180908180001",
"username": "admin",
"startTime":"2023-07-01",
"endTime":"2023-07-30"
}
-
-
- 返回值
-
{
"errCode": 0,
"resultMsg": "成功",
"resultData": {
"count": 1,
"data": [
{
"month": "2023-07",
"deptname": "视频设备",
"carnumber": "油B0003",
"terminal": "13610051256",
"runOilUse100km": 51.17,
"allOilUse100km": 65.81,
"workMileage": 83.82,
"oilUse": 55.16,
"idleOilUse": 12.27,
"oilAdd": 103.8,
"idleTime": 15541,
"oilLose": 0,
"oil": 246.88,
"workDay": 1,
"workTime": 30648,
"oilUseHour": 6.48
}
]
}
}
-
-
- 返回值说明
-
| 返回值参数名称 | 参数含义 | 数据类型 | 备注 |
| errCode | 状态码 | int | 0成功 其它失败 |
| resultMsg | 返回信息 | string | 成功返回成功，失败返回错误原因 |
| resultData |
resultData数据结构：
| 返回参数名称 | 返回值参数名称 | 参数含义 | 数据类型 | 说明 | |
| data | month | 月 | String | ||
| deptname | 部门名称 | String | |||
| carnumber | 车牌号 | String | |||
| runOilUse100km | 运行百公里油耗 | double | |||
| allOilUse100km | 综合百公里油耗 | double | |||
| workMileage | 工作里程 | double | |||
| oilUse | 耗油 | double | |||
| idleTime | 怠速时间,单位秒 | int | |||
| idleOilUse | 怠速油耗 | double | |||
| oilUse | 油耗 | double | |||
| oilAdd | 加油量 | double | |||
| oilLose | 漏油量 | double | |||
| oil | 最后油量 | double | |||
| workTime | 工作时长 | int | |||
| wokDay | 工作天数 | int | |||
| oilUseHour | 每小时油耗 | double | |||
| terminal | 终端标识 | string | |||
| count | 总记录数 | int | |||
212 超速报警(平台)
213-223 OBD相关报警
224 禁入区域(平台)
225 禁出区域(平台)
226 摄像头遮挡
227 未系安全带
228 双手脱离方向盘
