接口说明及错误码

参数编码

  • 字符集约定

所有的请求、响应、文本均使用UTF-8字符集进行编码，url里的所有参数请做URIEncode编码，各个参数进行URL编码（UTF-8）。

  • 参数名约定

客户端请求与响应中所有的参数名称都由字母、数字组成。组成参数名称的除了第一个单词，所有单词第一个字母大写，其他字母小写，例如result、departId。

  • 基本参数约定

日期格式都为yyyyMMddHHmmss, 例如：20180201135622 代表2018年02月01日13点56分22秒（此处仅表明格式，不代表精度，如精确到天等，具体精度由各业务确定）。 日期格式为yyyyMMdd，例如：20180201代表2018年02月01日。

  • 通用参数
参数名 参数类型 是否必需 描述
jssessionId string 是 用户登录返回的会话号
callback string 否 第三方通过JS调用Open API时可以通过指定callback参数来要求平台端返回JSONP代码，以解决跨域问题。callback参数值只能是字母数字下划线。

通用返回参数说明（json格式）
参数名 参数类型 描述
result number 0：正确返回
其它：失败。详细参见： 错误码说明
callback string 请求时所带的callback

正确调用JSONP示例
   $.ajax({
            type:'POST',
            url: 'http://192.168.1.8:52467/selectPost.dcw?callback=getData',
            data: data,
            cache:false,
             dataType:'JSONP',
            success: getData=function (data) {
               if(data.result == 0){
                  alert('Success');
               } else {
                  alert('Failure');
               }
       },
    });

错误码说明

错误码 说明
1 用户名不存在
2 密码错误
3 用户已停用
4 用户已过期
5 会话不存在
6 系统出现异常
7 请求参数不正确
8 没有操作设备权限
9 开始时间不得大于结束时间
10 查询时间超过范围
11 录像下载任务已存在
12 账号已存在
13 无操作权限
14 设备管理数目限制（已达到最大添加数目）
15 设备已存在
16 设备已被使用
17 设备不存在
18 设备不属于当前组织
19 设备注册数目不匹配，请检查设备数目是否超过注册数目！
20 设备不在线
21 没有此类设备类型
22 请求超时
23 车辆已绑定设备
24 添加车辆失败
25 添加员工失败
26 添加设备失败
27 修改设备失败
28 删除失败
29 删除车辆失败
30 删除员工失败
返回code码说明
200 成功
500 系统异常
40001 参数不正确
40002 参数为空
40003 账号或者密码错误
40004 userId不存在
40005 设备不在线
40020 参数为空
40024 db_table异常
40025 报警信息数据无
40026 设备未绑定存储服务器
40027 文件上传失败
40028 文件上传数据保存存储服务器失败
40029 文件在存储服务器中不存在
40030 存储服务器登录失败
40031 账号不存在
40032 jssessionid is error
40033 设备不在线
40034 account不存在
40035 无效account
40036 签名错误
40037 通道号不存在
40038 执法仪设备不存在
40039 设备录像或者录音时间<1分钟
50005 非法操作
50006 用户所属组织为空

用户与组织机构

用户登录

接口说明及错误码
用户登录
URL
/openApi/login.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
account string 是 无 登录账号
pwd string 是 无 登录密码
请求示例
返回参数说明
参数名 参数类型 描述
jssesionId string 登录后返回的会话号
code number 状态码，详细见状态码说明
msg string 返回的消息说明，消息描述说明
data object 返回的数据
正确返回示例
{
  	"code": 200,
  	"msg": "成功",
	"data": {
	"jssesionId": "fb465d7914ec76685bf52d3a602cd80f"
					}
		}

用户注销

接口说明及错误码
用户注销
URL
/openApi/logout.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 必填（放头部header）
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码，详细见状态码说明
msg string 返回的消息说明，消息描述说明
data object 返回的数据
正确返回示例
{
    "code": 200,
    "msg": "成功",
    "data": null
}

新增组织机构

接口说明及错误码
新增组织机构
URL
/openApi/addDept.dcw
HTTP请求方式
Get
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 必填（放头部header）
pid Integer 是 无 上级组织机构ID
pname String 是 无 组织机构名称
请求示例
返回参数说明
参数名 参数类型 描述 备注
code number 状态码
msg string 消息
data josnObject 数据体
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": []
}

获取组织机构

接口说明及错误码
根据登录用户获取其所有组织机构
URL
/openApi/dept/getDeptList.dcw
HTTP请求方式
Get
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 必填（放头部header）
请求示例
返回参数说明
参数名 参数类型 描述 备注
code number 状态码
msg string 消息
data josnObject 数据体
id number 组织机构ID
pid number 上级机构ID
name String 组织机构名称
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "id": 2,
            "pid": 1,
            "pname": null,
            "name": "xx支队",
            "level": null,
            "code": null,
            "tel": "",
            "rpsperson": "",
            "license": "",
            "own": 1,
            "logo": "",
            "fileName": null,
            "createTime": null,
            "updateTime": null,
            "playLogo": null,
            "deptSuoName": null
        }
    ]
}

设备信息查询

获取单个设备信息

接口说明及错误码
查询终端列表
URL
/openApi/deviceInfoByVin.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话ID （必填，放头部header）
vin string 是 无 设备编号 （必填）
请求示例
返回参数说明
参数名 参数类型 描述 备注
code number 状态码
msg string 消息
data josnObject 数据体
termSn string 设备唯一标志TermSn
nmsName string 设备编号
userTypeId number 设备类型 1：车载2：执法仪3：布控球
departName string 设备所属组织机构名称
bindingName string 车牌号或者员工名称 -1：表示未绑定车辆或者员工
status number 表示是否定位 0：未定位 1：定位
onLine number 是否上下线 0：不在线1：上线
latitude string 纬度(末次位置的) WGS-84
isBinded number 设备是否进行了绑定（车辆或者员工） -1：未绑定 1：已绑定
latitudeType number 纬度类型 0：未定位1：S南纬2：N北纬
longitudeType number 经度类型 0：未定位1：W西经2：E东经
channelList array 通道号列表
channelNo number 通道号编号
name string 通道号名称
termSn string 设备唯一标志TermSn
正确返回示例
 {
"code": 200,
"msg": "成功",
"data": {
"termSn": "100000000209",
"nmsName": "df185000",
"latitude": null,
"longitude": null,
"latitudeType": 0,
"longitudeType": 0,
"userTypeId": 2,
"onLine": 1,
"status": 0,
"statusStr": "未定位",
"authenticato": null,
"bindingName": "java",
"departName": "dcw",
"channelList": [
            {
"termSn": "100000000209",
"channelNo": 1,
"name": "通道1",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
            },
            {
"termSn": "100000000209",
"channelNo": 2,
"name": "通道2",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
            },
            {
"termSn": "100000000209",
"channelNo": 3,
"name": "通道3",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
            }
        ]
    }
}

获取设备列表信息

接口说明及错误码
查询终端列表
URL
/openApi/getDeviceInfoList.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话ID （必填，放头部header）
orgIds string 否 无 组织机构ID 通过/openApi/dept/getDeptList.dcw获取，可多个，如1,2,3
返回参数说明
参数名 参数类型 描述 备注
code number 状态码
msg string 消息
data josnObject 数据体
termSn string 设备唯一标志TermSn
nmsName string 设备编号
userTypeId number 设备类型 1：车载2：执法仪3：布控球
departName string 设备所属组织机构名称
bindingName string 车牌号或者员工名称 -1：表示未绑定车辆或者员工
status number 表示是否定位 0：未定位 1：定位
onLine number 是否上下线 0：不在线1：上线
latitude string 纬度(末次位置的) WGS-84
isBinded number 设备是否进行了绑定（车辆或者员工） -1：未绑定 1：已绑定
latitudeType number 纬度类型 0：未定位1：S南纬2：N北纬
longitudeType number 经度类型 0：未定位1：W西经2：E东经
channelList array 通道号列表
channelNo number 通道号编号
name string 通道号名称
termSn string 设备唯一标志TermSn
正确返回示例
 {
"code": 200,
"msg": "成功",
"data": [
        {
"termSn": "100000000176",
"nmsName": "java1002",
"latitude": null,
"longitude": null,
"latitudeType": 0,
"longitudeType": 0,
"userTypeId": 2,
"onLine": 0,
"status": 0,
"statusStr": "未定位",
"authenticato": null,
"bindingName": "-1",
"departName": "ROOT",
"channelList": [
                {
"termSn": "100000000176",
"channelNo": 1,
"name": "通道1",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
                }
            ]
        },{
"termSn": "100000000025",
"nmsName": "java1001",
"latitude": 22.712422,
"longitude": 114.336906,
"latitudeType": 2,
"longitudeType": 2,
"userTypeId": 2,
"onLine": 1,
"status": 0,
"statusStr": "未定位",
"authenticato": null,
"bindingName": "特朗普",
"departName": "dcw",
"channelList": [
                {
"termSn": "100000000025",
"channelNo": 1,
"name": "通道1",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
                },
                {
"termSn": "100000000025",
"channelNo": 2,
"name": "通道2",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
                },
                {
"termSn": "100000000025",
"channelNo": 3,
"name": "通道3",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
                },
                {
"termSn": "100000000025",
"channelNo": 4,
"name": "通道4",
"linkType": null,
"codeType": null,
"ptzType": null,
"num": null
                }
            ]
        }

]}

根据车辆/员工编号获取设备号

接口说明及错误码
查询终端列表
URL
/openApi/deviceInfoByVin.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话ID （必填，放头部header）
vin string 是 无 设备号，多个可用，分割 须已登录
请求示例
返回参数说明
参数名 参数类型 描述
termSn string 设备编号
nmsName string 设备名称
latitude string 纬度
longitude string 经度
latitudeType number 南北纬 默认为0:未定位 1南纬 2北纬
longitudeType number 东西经 默认为0:未定位 1西经 2东经
userTypeId number 是否在线，0：未在线 1：在线 -1:从未上过线
status string 808协议状态码
statusStr number 808协议状态码 转码
isBinded string 是否被绑定（0：未绑定、1：绑定）
authenticato number 设备鉴权码：设备未绑定为null
bindingName number 绑定对象的名称
departName string 组织名称
channelList List 通道列表
termSn string 设备编号
channelNo string 通道号
name string 通道名称
agreementType string 1:808协议 2:28181
endPosTermSn string 设备号
statusTermSn string 设备号
positionStatus string 定位状态：1：在线定位 2：在线未定位 3：未在线
nmsAlias string 设备名称
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "termSn": "1000000021",
        "nmsName": "8603011001",
        "latitude": 25.1174,
        "longitude": 117.0222,
        "latitudeType": 2,
        "longitudeType": 2,
        "userTypeId": 3,
        "onLine": 0,
        "status": 0,
        "statusStr": "未定位",
        "isBinded": 0,
        "authenticato": null,
        "bindingName": "测试2",
        "departName": "科技有限公司",
        "channelList": [
            {
                "termSn": "100002152",
                "channelNo": 1,
                "name": "通道1",
                "linkType": null,
                "codeType": null,
                "ptzType": null,
                "agreementType": 1,
                "num": null,
                "selectValue": null,
                "selectName": null
            }
        ],
        "endPosTermSn": "100002152",
        "statusTermSn": "1002152",
        "positionStatus": 0,
        "nmsAlias": "测试2"
    }
}

获取设备在线信息

接口说明及错误码
查询终端列表
URL
/openApi/GainDeviceInfoByTermSns.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
termSnStr string 是 无 设备唯一标志TermSn （可多个，用,分开） TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
jssesionId string 是 无 会话id 必填（放头部header）
返回参数说明
参数名 参数类型 描述
termSn string 设备唯一标志
online number 在线状态，1表示在线，否则不在线
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "termSn": "100000000000",
            "online": 1
        },
        {
            "termSn": "100000000001",
            "online": 0
        }
    ]
}

获取设备在线状态

接口说明及错误码
查询终端列表
URL
/openApi/deviceInfoByTermSn.dcw
HTTP请求方式
POST
输入参数说明
返回的数据格式
json

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码
msg string 消息
data object 数据集
online number 1：在线，0：不在线
正确返回示例
  {
"code": 200,
"msg": "成功",
"data": {
"online": 1
    }
}

获取设备定位状态及经纬度（末次位置）

接口说明及错误码
查询终端列表
URL
/openApi/getDeviceGPStatus.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
请求示例
返回参数说明
参数名 参数类型 描述 备注
code number 状态码
msg string 消息
data object 数据集
vin string 设备绑定的人员名称或者车牌号
vid string 设备绑定的人员id或者车辆id（唯一标识）
status number 设备定位状态 0：表示未定位，1：已定位
time string gps刷新上报的时间
latitude number 纬度（末次位置） WGS-84
longitude number 经度（末次位置） WGS-84
termSn string 设备唯一标识
speed number 速度 单位（km/h）
directionType number 方向类型 0、北，1、东北，2、东，3、东南，4、南，5、西南，6、西、7、西北
正确返回示例
 {
"code": 200,
"msg": "成功",
"data": {
"id": null,
"vid": "357adfd6b5f0434f8c83db93a7a7668b",
"vin": "特朗普",
"status": 1,
"time": "2019-12-10 15:39:11.0",
"latitude": 22.712422,
"longitude": 114.336906,
"altitude": 0,
"speed": 36.4,
"direction": 0,
"termSn": "100000000025",
    }
}

获取设备实时GPS信息

接口说明及错误码
查询终端列表
URL
/openApi/getDeviceGPS.dcw?nmsNames=123565956322&toMap=3
HTTP请求方式
GET
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话id 必填（放头部header）
nmsNames string 是 无 设备编号，多个可用“，”分割
toMap number 否 3 地图经纬度转换1表示经纬度转为百度地图，2表示经纬度转为高德地图，3表示经纬度转为谷歌地图，默认转为谷歌地图经纬度
请求示例
返回参数说明
参数名 参数类型 描述
vid string 司机ID
vin string 设备名称
termSn string 设备内部号
nmsName string 设备编号
status string 状态，0：表示未定位，1：已定位
time string GPS上传时间
longitude number 经度,当设备定位无效，值为0。
latitude number 纬度,当设备定位无效，值为0。
altitude number 高度
speed number 速度，单位：km/h
direction number 方向
directionType number 方向类型，0、北，1、东北，2、东，3、东南，4、南，5、西南，6、西、7、西北
alarmType string 报警类型
driverName string 司机姓名
identity string 身份
oilMass number 油量
mileage number 里程
addSpeed number 加速度
nEnergy number 电量
nVolume number 声音
nDiskMax number 设备磁盘大小
wifiType number wifi状态
wifiAddress string Wifi地址
softwareVersion string 软件版本
recordAudio number 录音状态
recordVideo number 录像状态
nDiskRest number 剩余磁盘大小
latLongitude string 经纬度
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "id": null,
            "vid": null,
            "vin": "8603011001295",
            "colorId": null,
            "colorName": null,
            "status": 0,
            "time": "2023-07-24 09:47:44",
            "latitude": 39.10386,
            "longitude": 107.98655,
            "altitude": null,
            "speed": 0.0,
            "direction": 359.0,
            "directionType": 0,
            "alarmType": 0,
            "driverName": null,
            "identity": null,
            "termSn": "10000000148",
            "oilMass": null,
            "mileage": null,
            "addSpeed": null,
            "nEnergy": "68",
            "nVolume": "22.22",
            "nDiskMax": "62",
            "wifiType": "1",
            "wifiAddress": "192.168.50.000",
            "softwareVersion": "1.8.1_570_2022082404_ZX",
            "recordAudio": "0",
            "recordVideo": "0",
            "nDiskRest": "62",
            "latLongitude": "107.98655,39.10386",
            "infoEx": null
        }
    ]
}

分页获取设备轨迹信息1

接口说明及错误码
分页获取设备轨迹信息1
URL
/openApi/getDeviceTrackPage.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName string 是 无 设备编号（必填）
startTime string 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
page String 是 无 分页参数：第几页（可选）默认为1：表示第一页
rows String 是 无 分页参数：每页显示几条数据（可选）默认为5：表示每页显示5条数据
返回参数
参数名 说明 描述
code 状态码 200表示成功
msg 消息
data 数据体
time gps时间 该点gps定位的时间
latitude 纬度 WGS-84
longitude 经度 WGS-84
speed 速度（km/h）
latitudeType 纬度类型 南北纬 1：S ，2：N
longitudeType 经度类型 东西经 1：W ，2：E
alarmStatus 报警类型 -1：正常,-2：表示其他类型报警,0~31:参数报警类型表
alarmType 报警数值
page 第几页
pageSize 第几页 每页显示的数量
records 报警总条数
directionType 方向类型 0、北，1、东北，2、东，3、东南，4、南，5、西南，6、西、7、西北
direction 方向数值 不必理会已帮你处理
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"page": 1,
"pageSize": 2,
"orderBy": null,
"order": "ASC",
"rows": [
            {
"id": 1405,
"status": 70,
"time": "2019-12-10 10:24:01",
"latitude": 22.712422,
"longitude": 114.337906,
"latitudeType": 1,
"longitudeType": 2,
"altitude": 0,
"speed": 36.4,
"direction": 241,
"directionType": 5,
"alarmType": 0,
"alarmStatus": -1,
"termSn": "100000000025",

            },
            {
"id": 1415,
"status": 80,
"time": "2019-12-10 10:24:16",
"latitude": 22.712422,
"longitude": 114.340906,
"latitudeType": 2,
"longitudeType": 2,
"altitude": 0,
"speed": 36.4,
"direction": 33,
"directionType": 1,
"alarmType": 0,
"alarmStatus": -1,
"termSn": "100000000025",

            }
        ],
"records": 2916,
"autoCount": false,
"start": 0,
"total": 1458,
"asc": true,
"nextEnabled": true,
"inverseOrder": "DESC",
"previousEnabled": false,
"orderEnabled": false,
"pageSizeEnabled": true,
"startEnabled": true,
"totalEnabled": true
    }
}

获取设备轨迹信息列表2

接口说明及错误码
获取设备轨迹信息列表2
URL
/openApi/getDeviceTrackList.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName string 否 无 设备编号
termSnStr string 是 无 设备唯一标志TermSn （可多个，用,分开）TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
startTime string 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
返回参数
参数名 说明 描述
code 状态码 200表示成功
msg 消息
data 数据体
time 设备唯一标识
termSn gps时间 该点gps定位的时间
latitude 纬度 WGS-84
longitude 经度 WGS-84
speed 速度（km/h）
latitudeType 纬度类型 南北纬 1：S ，2：N
longitudeType 经度类型 东西经 1：W ，2：E
alarmStatus 报警类型 -1：正常,-2：表示其他类型报警,0~31:参数报警类型表
alarmType 报警数值
status gps状态码 不必理会已处理
directionType 方向类型 0、北，1、东北，2、东，3、东南，4、南，5、西南，6、西、7、西北
direction 方向数值 不必理会已帮你处理了，使用directionType这个字段
返回示例
{
"code": 200,
"msg": "成功",
"data": [
        {
"id": 1405,
"status": 70,
"time": "2019-12-10 10:24:01",
"latitude": 22.712422,
"longitude": 114.337906,
"latitudeType": 1,
"longitudeType": 2,
"altitude": 0,
"speed": 36.4,
"direction": 241,
"directionType": 5,
"alarmType": 0,
"alarmStatus": -1,
"termSn": "100000000025",
"nenergy": null,
"ndiskRest": null,
"nvolume": null,
"ndiskMax": null
        },
        {
"id": 1415,
"status": 80,
"time": "2019-12-10 10:24:16",
"latitude": 22.712422,
"longitude": 114.340906,
"latitudeType": 2,
"longitudeType": 2,
"altitude": 0,
"speed": 36.4,
"direction": 33,
"directionType": 1,
"alarmType": 0,
"alarmStatus": -1,
"termSn": "100000000025",
"nenergy": null,
"ndiskRest": null,
"nvolume": null,
"ndiskMax": null
        }
]
}

查询录音或者录像的状态（限流）

接口说明及错误码
查询录音或者录像的状态（限流）
URL
/openApi/getRecordAudioAndRecordVideoStatus.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName string 是 无 设备编号（必填）
返回参数
参数名 说明 描述
code 状态码 200表示成功
msg 消息
data 数据体
status 查询录音或者录像状态码 0:成功,-1：失败
recordVideoIntStatus 影像状态 1：正在录像,2：未录像
recordAudioStatus 录音状态 1：正在录音,2：未录音
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"recordVideoIntStatus": 1,
"status": 0,
"recordAudioStatus": 2
    }
}

停止播放媒体回放

接口说明及错误码
停止播放媒体回放
URL
/openApi/stopHistoryMedia.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName string 是 无 设备编号（必填）
videoId string 是 无 视频id，从播放媒体回放音视频接口获取，用于关闭（唯一标识）（必填）
返回参数
参数名 说明 描述
code 状态码 200表示成功
msg 消息
data 数据体
errorcode 关闭媒体回放视频状态码 0：成功
videoId 视频id 用于关闭播放的视频
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"error": {
"errorcode": "0",
"errormsg": "",
"data": null
        },
"userId": null,
"videoId": "72210853",
"address": null,
"url": null,
"urlIn": null
    }
}

获取设备报警数据(分页)

接口说明及错误码
查询设备报警数据(分页)
URL
/openApi/getAlarmListPage.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSnStr string 否 无 设备唯一标志TermSn （可多个，用,分开）TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
type number 否 无 报警类型，以，分割，若为空，则查询所有类型
handle number 否 无 处理状态 1表示已处理，0表示未处理，其他则查询所有
page number 否 1 页码
pageSize number 否 100 每页条数
请求示例
返回参数说明
参数名 参数类型 描述
alarmInfo Array 报警信息
alarmType number 报警类型，详细参见：报警类型说明
alarmDsc string 报警类型中文
termSn string 设备编号
vin string 车牌号/员工编号
endTime string 报警结束时间，秒数
startTime string 报警开始时间，秒数
id string 报警唯一编号
dealStatus string 处理状态，1表示已处理，null表示未处理
dealMan number 处理人
dealDescription string 处理描述
dealTime string 处理时间
maxSpeed number 报警最大速度
minSpeed number 报警最小速度
page number 当前页
tatal number 查询数据总页码
pageSize number 每页记录条数
Records number 查询数据记录总条数
result number 返回结果代码，详情参见：错误代码
正确返回示例
   {
    "result": "0",
    "alarmInfo":[{...}],
    "totalPage":"5",
    "page": "1",
    "pageSize": "50",
    "totalRecords": "235"
  }

获取设备实时报警数据

接口说明及错误码
查询设备实时报警数据
URL
/openApi/getAlarmList.dcw?jssesionId=cf6b70a3-c82b-4392-8ab6-bbddce336222&termSn=075500000100&toMap=3&type=2&analayze=1
HTTP请求方式
GET/POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 是 无 设备编号
type number 否 无 报警类型，以，分割，若为空，则查询所有类型
analayze number 否 无 是否解析地理位置信息，1表示解析，其他不解析
toMap number 否 3 地图经纬度转换1表示经纬度转为百度地图，2表示经纬度转为高德地图，3表示经纬度转为谷歌地图，默认转为谷歌地图经纬度
请求示例
返回参数说明
参数名 参数类型 描述
alarmInfo Array 报警信息
termSn string 设备编号
vin string 车牌号/员工编号
alarmTime string 报警时间，秒数
type number 报警类型，详细参见：报警类型说明
guid string 报警唯一编号
dealStatus string 处理状态，1表示已处理，0表示未处理
dealMan number 处理人
dealContent string 处理描述
dealTime string 处理时间
Speed number 报警速度
lat number 报警纬度
lng number 报警经度
location string 报警地理位置
result number 返回结果代码，详情参见：错误代码
正确返回示例
   {
    "result": "0",
    "alarmInfo":[{...}]
  }

发送短消息到设备

接口说明及错误码
发送短消息到设备
URL
/openApi/vehicleSchedu.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 是 无 设备编号
tag string 是 00000000 标签
txtContent string 是 无 发送消息内容
请求示例
返回参数说明
参数名 参数类型 描述
data string 0：发送成功 1：发送失败
result number 返回结果代码，详情参见：错误代码
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": "0"
}

视频相关业务

接口说明及错误码
初始化视频插件
(1)web客户端使用flash插件
(2)引入jQuery 和 swfplay
<script src="../jquery.min.js"></script>
<script src="../swfplay.js"></script>
(3)准备HTML代码
<div id="videoflash"></div>
(4)JavaScript代码
参见：参考JavaScript代码
引用文件

文件列表

文件 说明
调用方法

（1）视频插件的初始化方法 embedSWF(swfUrlStr, replaceElemIdStr, width, height,object);

参数名 参数类型 是否必需 描述
swfUrlStr string 是 视频插件路径相对路径或者绝对路径。
replaceElemIdStr string 是 页面HTML标签id属性,通常为videoflash
width number 是 视频插件宽度
height number 是 视频插件高度
object number 是 媒体类型(1：实时视频、2：监听、3：对讲)

（2）设置视频插件的窗口数目 setWindowNum(splitNum);

参数名 参数类型 是否必需 描述
splitNum number 是 窗口数目（最多为16）

（3）设置视频插件的服务器 initServer(ip,port);

参数名 参数类型 是否必需 描述
ip string 是 登录服务器ip
port number 是 登录服务器端口
操作实例

参考JavaScript代码

   {
            //初始化flash
            var swf=new swfobject();
           swf.embedSWF("StrobeMediaPlayback.swf", "videoTest", 400, 400,1);
           //设置窗口数量
           swf.setWindowNum(6);
           //设置服务器地址
           swf.initServer("119.136.18.75","52467");
  }
接口说明及错误码
实时视频（网页集成）
可直接调用网页链接观看实时视频。
引用文件

无

网页集成链接参数说明
参数名 参数类型 是否必需 默认值 描述
jssessionId string 否 无 用户登录返回的会话号 如果为空，则判断用户名和密码。
account string 否 无 登录账号 如果会话号为空，则判断用户名和密码。 如果用户名和密码为空，则判断后台配置的用户名和密码。
pwd string 否 无 登录密码
termSn string 否 无 设备号如果为空，则判断车牌号
vin string 否 无 车牌号如果设备号为空，则判断车牌号。
channel number 否 无 预览视频的通道数目最大支持6个窗口播放
操作实例
接口说明及错误码
实时视频（JavaScript）
引用文件

文件列表

文件 说明
调用方法

（1）视频插件的初始化方法 embedSWF(swfUrlStr, replaceElemIdStr, width, height,object);

参数名 参数类型 是否必需 描述
swfUrlStr string 是 视频插件路径相对路径或者绝对路径。
replaceElemIdStr string 是 页面HTML标签id属性,通常为videoflash
width number 是 视频插件宽度
height number 是 视频插件高度
object number 是 媒体类型(1：实时视频、2：监听、3：对讲)

（2）设置视频插件的窗口数目 setWindowNum(splitNum);

参数名 参数类型 是否必需 描述
splitNum number 是 窗口数目（最多为16）

（3）播放视频 startVideo(index,jssessionId,termSn,channel)

参数名 参数类型 是否必需 描述
index number 是 窗口下标（从1开始）
jssessionId string 是 用户登录返回的会话号
termSn string 是 设备号
channel number 是 设备通道（从1开始）

(4)停止播放视频 stopVideo(index,jssessionId)

参数名 参数类型 是否必需 描述
index number 是 窗口下标（从1开始）
jssessionId string 是 用户登录返回的会话号

(5)重置视频窗口 reSetVideo(index)

参数名 参数类型 是否必需 描述
index number 是 窗口下标（从1开始）
操作实例

操作实例

参考JavaScript代码

   {
            //初始化flash
            var swf=new swfobject();
           swf.embedSWF("./rtmp_player/StrobeMediaPlayback.swf", "videoTest", 400, 400,1);
           //设置窗口数量
           swf.setWindowNum(6);
           //播放视频
	function playVideo() {
	      //停止播放视频
	      swfobject.stopVideo(1, "cf6b70a3c82b43928ab6bbddce336222");
	      //播放视频
	      swfobject.startVideo(1, "cf6b70a3c82b43928ab6bbddce336222", "10000", 0, 1);
	}
	//停止播放视频
	function stopVideo() {
	      swfobject.stopVideo(0);
	}
	//重置视频窗口
	function reSetVideo() {
	      swfobject.reSetVideo(0);
	}
  }

获取实时视频（多协议）

接口说明及错误码
查询终端列表
URL
/openApi/videoMoni.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
channelId string 是 无 视频通道编号（必填）
stamp string 是 无 码流类型 码流类型 1：子码流 0：主码流（不填默认为：1）
talkId string 是 无 时间戳 用于关闭视频
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码
msg string 消息
data object 数据集
videoId string 视频id,用于关闭本次请求视频
errorcode string 状态码,0:成功/-1:超时
id string TermSn设备唯一标识
channel string 通道号
svr string 实时流视频地址（hls、flv、rtsp、ts、mp4等）
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "videoId": "666",
        "error": {
            "errorcode": "0",
            "errormsg": "",
            "data": null
        },
        "dev": {
            "id": "100000000007",
            "channel": "1"
        },
        "svr": {
            "url": "rtmp://172.18.20.75:52471/live/00070101",
            "ip": "127.0.0.1",
            "port": "57112",
            "hls": "http://172.18.20.75:52472/live/00070101/hls.m3u8",
            "flv": "http://172.18.20.75:52472/live/00070101.live.flv",
            "rtsp": "rtsp://172.18.20.75:52478/live/00070101",
            "ts": "http://172.18.20.75:52472/live/00070101.live.ts",
            "mp4": "http://172.18.20.75:52472/live/00070101.live.mp4"
        },
        "subtopic": "100000000007_1_1",
        "header": "",
        "boxId": null
    }
}

关闭实时视频

接口说明及错误码
查询终端列表
URL
/openApi/videoStop.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
videoId string 是 无 视频id
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码
msg string 消息
data object true:关闭成功,-1:超时,false:关闭失败
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": "true"
}

请求对讲

接口说明及错误码
查询终端列表
URL
/openApi/voiceCalls.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
errorcode number 请求对讲的状态码(0：表示成功,-1：请求超时,7：表示服务器语音对讲被占用)
talkId string (音频id)用于关闭对讲听
urlIn string 音频推流拉流地址
webId string 对讲群组webId
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "error": {
            "errorcode": "0",
            "errormsg": "talking",
            "data": null
        },
        "userId": null,
        "talkId": "74204817",
        "address": "",
        "url": null,
        "urlIn": "ws://172.18.20.75:52489/websocket",
        "webId": "web:10000007"
    }
}

关闭对讲

接口说明及错误码
查询终端列表
URL
/openApi/stopVoiceCalls.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
talkId string 是 无 对讲id 对讲id（用于关闭对讲）请求对讲获取
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
errorcode number 请求对讲的状态码(0：表示成功,-1：请求超时)
talkId string 音频id
正确返回示例
{
"code": 200,
"msg": "成功",
"data": {
"error": {
"errorcode": "0",
"errormsg": "",
"data": null
        },
"userId": null,
"talkId": "67845001",
"address": null,
"url": null,
"urlIn": null
    }
}

请求广播

接口说明及错误码
查询终端列表
URL
/openApi/broadcastVoiceCalls.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
termSnStr string 是 无 设备唯一标志TermSn （可多个，用,分开） TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
errorcode number 请求广播的状态码(0：表示成功,-1：请求超时)
talkId string 音频id 用于关闭广播
urlIn string 广播推流地址
webId string 对讲群组webId
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "error": {
            "errorcode": "0",
            "errormsg": "talking",
            "data": null
        },
        "userId": null,
        "talkId": "5",
        "address": null,
        "url": null,
        "urlIn": "ws://172.18.20.75:52489/websocket",
        "webId": "web:90000005"
    }
}

关闭广播

接口说明及错误码
查询终端列表
URL
/openApi/stopbroadcast.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
termSnStr string 是 无 设备唯一标志TermSn （可多个，用,分开） TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
talkId string 是 无 音频ID 请求广播中返回的talkId
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
errorcode number 关闭广播的状态码(0：表示成功,-1：请求超时,-2:音频ID未找到)
talkId string 音频id 用于关闭广播
urlIn string 广播推流地址
webId string 广播webId
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "error": {
            "errorcode": "0",
            "errormsg": "",
            "data": null
        },
        "userId": null,
        "talkId": "5",
        "address": null,
        "url": null,
        "urlIn": null,
        "webId": null
    }
}

下载 对讲、广播网页实现Demo

创建集群对讲

接口说明及错误码
创建集群对讲，创建成功后，设备主菜单 “集群对讲” 功能会出现新的群组
URL
/openApi/group/createGisGroup.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
groupName string 是 无 群组名称
termSnStr string 是 无 设备唯一标志TermSn （可多个，用,分开） TermSn在获取设备信息接口中的TermSn字段返回，如：100000000009
请求参数示例
{"groupName":"群组名","termSnStr":"100000000009,100000000007"}
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

删除集群对讲

接口说明及错误码
URL
/openApi/group/deleteGroup.dcw
HTTP请求方式
Get
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
groupId string 是 无 群组ID
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

获取集群/群组列表(分页)

接口说明及错误码
获取集群/群组列表(分页)
URL
/openApi/group/getGroupListPage.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
groupName string 否 无 群组名称
groupType String 否 无 群类型：0：普通群 1：临时群（默认为0）2：无效的临时群，3:默认群组(组织管理)
page number 否 1 页码
pageSize number 否 10 每页条数
请求示例
返回参数说明
参数名 参数类型 描述
groupId String 群组ID
groupName String 群组名
createTime string 创建时间
updateTime string 修改时间
departName string 组织机构名称
groupType string 群类型 0：普通群 1：临时群（默认为0）2：无效的临时群，3:默认群组(组织管理)
records int 数据总条数
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "page": 1,
        "pageSize": 1,
        "orderBy": null,
        "order": "ASC",
        "rows": [
            {
                "id": 3,
                "groupId": "6d0456109ab54c0b8b68f902f8b9d5bc",
                "groupName": "888",
                "groupNameAllPin": "888",
                "groupNameSuoPin": "888",
                "departId": 1,
                "creator": null,
                "createTime": 1676000735000,
                "updateTime": 1676000735000,
                "lastOperator": null,
                "groupType": 0,
                "source": null,
                "lastSource": null,
                "memberNum": 1,
                "departName": "调度中心"
            }
        ],
        "records": 1,
        "autoCount": false,
        "start": 0,
        "total": 1,
        "asc": true,
        "startEnabled": true,
        "nextEnabled": false,
        "inverseOrder": "DESC",
        "orderEnabled": false,
        "totalEnabled": true,
        "previousEnabled": false,
        "pageSizeEnabled": true
    }
}

云台控制

接口说明及错误码
URL
/openApi/requestPtzControl.dcw
HTTP请求方式
Get/Post
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号
channel string 是 无 通道号
cmd string 是 无 控制命令代码 详见PTZ云台控制说明
speed Integer 否 1 速度
请求示例
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
正确返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

开启或者关闭录音和录像

接口说明及错误码
查询终端列表
URL
/openApi/requestDevicesRecordOrVideo.dcw
HTTP请求方式
POST
返回的数据格式
json
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述 备注
jssesionId string 是 无 会话id 必填（放头部header）
nmsName string 是 无 设备编号（必填）
command string 是 无 请求媒体类型 1:表示录像 2:表示录音
flag string 是 无 请求指令类型 1：表示开启录像或者录音,0：表示关闭录像或者录音
time Integer 是 无 媒体录制时间 要整数值，表示录像或者录音的时间长度。必须大于等于1（单位：分钟）
返回参数说明
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data object 数据集
正确返回示例
{
"code": 200,
"msg": "成功",
"data": null
}
接口说明及错误码
监听
引用文件

文件列表

文件 说明
调用方法

（1）视频插件的初始化方法 embedSWF(swfUrlStr, replaceElemIdStr, width, height,object);

参数名 参数类型 是否必需 描述
swfUrlStr string 是 视频插件路径相对路径或者绝对路径。
replaceElemIdStr string 是 页面HTML标签id属性,通常为videoflash
width number 是 视频插件宽度
height number 是 视频插件高度
object number 是 媒体类型(1：实时视频、2：监听、3：对讲)

（2）开始监听 startListenOrTalk(jssessionId, termSn, channel,isTalk);

参数名 参数类型 是否必需 描述
jssessionId string 是 用户登录返回的会话号
termSn string 是 设备号
channel number 是 设备通道（1）
isTalk number 是 0表示监听,1表示对讲

（3）停止监听 stopListenOrTalk(jssessionId,termSn)

参数名 参数类型 是否必需 描述
jssessionId string 是 用户登录返回的会话号
termSn string 是 设备号
操作实例

操作实例

参考JavaScript代码

   {
            //初始化flash
            var swf=new swfobject();
           swf.embedSWF("./rtmp_player/StrobeMediaPlayback.swf", "listenTest", 400, 400,2);
			//开始监听
		function startMonitor() {
		      swf.startListenOrTalk("cf6b70a3c82b43928ab6bbddce336222", "10000", 1,0);
		}
		//停止监听
		function stopMonitor() {
		     swf.stopListenOrTalk("cf6b70a3c82b43928ab6bbddce336222", "10000");
		}
  }
接口说明及错误码
对讲
引用文件

文件列表

文件 说明
调用方法

（1）视频插件的初始化方法 embedSWF(swfUrlStr, replaceElemIdStr, width, height,object);

参数名 参数类型 是否必需 描述
swfUrlStr string 是 视频插件路径相对路径或者绝对路径。
replaceElemIdStr string 是 页面HTML标签id属性,通常为videoflash
width number 是 视频插件宽度
height number 是 视频插件高度
object number 是 媒体类型(1：实时视频、2：监听、3：对讲)

（2）开始对讲 startListenOrTalk(jssessionId, termSn, channel,isTalk);

参数名 参数类型 是否必需 描述
jssessionId string 是 用户登录返回的会话号
termSn string 是 设备号
channel number 是 设备通道（1）
isTalk number 是 0表示监听,1表示对讲

（3）停止对讲 stopListenOrTalk(jssessionId,termSn)

参数名 参数类型 是否必需 描述
jssessionId string 是 用户登录返回的会话号
termSn string 是 设备号
操作实例

操作实例

参考JavaScript代码

   {
            //初始化flash
            var swf=new swfobject();
           swf.embedSWF("./rtmp_player/StrobeMediaPlayback.swf", "talkTest", 100, 100,3);
			//开始对讲
		function startTalk() {
		      swf.startListenOrTalk("cf6b70a3c82b43928ab6bbddce336222", "10000", 1,1);
		}
		//停止对讲
		function stopTalk() {
		     swf.stopListenOrTalk("cf6b70a3c82b43928ab6bbddce336222", "10000");
		}
  }
接口说明及错误码
PTZ控制
URL
/openApi/ptzControl.dcw?jssesionId=cf6b70a3-c82b-4392-8ab6-bbddce336222&termSn=075500000100&channel=1&command=2&speed=5
HTTP请求方式
GET/POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 是 无 设备编号
channel number 是 无 设备通道（从1开始）
command number 是 无 控制指令编号，详细参见：控制指令说明
speed number 是 无 速度，当为方向移动，速度有效，范围0-100
请求示例
返回参数说明
参数名 参数类型 描述
result number 返回结果代码，详情参见：错误代码
正确返回示例
   {
    "result": "0",
  }

文件相关业务

播放媒体回放音视频文件1（设备端获取）

接口说明
播放媒体回放音视频文件1（设备端获取）
URL
/openApi/playDevicesHistoryMedia.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName String 是 无 设备编号（必填）
channel String 是 无 通道号（必填）
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
type String 是 无 2：视频,4：音频（必填）
返回参数
参数名 参数类型 描述
code number 状态码(200表示成功)
msg string 消息
data Object 数据体
errorcode string 播放设备端视频状态码(0：成功,-2：正忙)
videoId string 视频id(用于关闭播放的视频)
url string 推拉流地址：Rtmp协议
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"error": {
"errorcode": "0",
"errormsg": "",
"data": null
        },
"userId": null,
"videoId": "72571090",
"address": null,
"url": "rtmp://192.168.1.86:52481/live/100000010091_2_3",
"urlIn": null
    }
}

播放媒体回放音视频文件2（存储服务器获取）

接口说明
播放媒体回放音视频文件2（存储服务器获取）
URL
/openApi/playDevicesHistoryMedia.dcw
HTTP请求方式
get
返回数据类型
媒体流
请求参数
非json格式

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName String 是 无 设备编号（必填）
channel String 是 无 通道号（必填）
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
type String 是 无 2：视频,4：音频（必填）
返回示例
返回的是视频流
视频contentType： audio/x-wav

音频contentType: video/mp4

查询媒体回放图片文件1（设备端获取）

接口说明
查询媒体回放图片文件1（设备端获取）
URL
/openApi/searchImageSourceDevicesList.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName String 是 无 设备编号（必填）
channel String 是 无 通道号（必填）
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
source String 是 无 1：表示从设备端获取
type String 是 无 1：图片（必填）

查询媒体回放图片文件2（存储服务器获取）

接口说明
查询媒体回放图片文件2（存储服务器获取）
URL
/openApi/searchImageSourceServerList.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName String 是 无 设备编号（必填）
channel String 是 无 通道号（必填）
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
page Integer 是 无 分页参数：默认为1表示第一页
rows Integer 是 无 分页参数：默认为10表示显示多少条记录

上传音视频文件（设备端上传）

接口说明
上传音视频文件（设备端上传）
URL
/openApi/frontEndDevicesFileUpload.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName String 是 无 设备编号（必填）
channel String 是 无 通道号（必填）
startTime String 是 无 开始时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
endTime String 是 无 结束时间：格式必须遵循（yyyy-MM-dd HH:mm:ss）必填，只能查询一天的记录不能跨年、跨天、跨月查询
audioType String 是 无 2：视频（必填）,4：音频
size String 是 无 文件大小（必填）
请求参数样例：
						{
	"nmsName":"d51a8000",
	"channel":"1",
	"startTime":"2019-12-10 00:00:00",
	"endTime":"2019-12-10 23:59:59",
	"audioType":"2",
		"size":"835284736"

}
返回参数
参数名 说明 描述
code 状态码 200表示成功，203表示该文件已上传过了
msg 消息
fileMsg 文件上传唯一消息 用于查询文件上传的进度及文件下载
返回示例
{
"code": 203,
"msg": "成功",
"data": {
"fileMsg": “Video/d51a8000/2019_12_10/d51a8000_java1001_1_20191210173616.mp4”
    }
}

获取设备端正在上传音视频状态（限流）

接口说明
获取设备端正在上传音视频状态（限流）
URL
/openApi/getFileUploadStatus.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
fileMsg String 是 无 用于获取正在上传音视频文件状态 唯一标识（必填）
返回参数
参数名 说明 描述
code 状态码(200表示成功)
msg 消息
data 数据体
fileUploadStatus 文件正在上传的状态值 1：已上传成功,0：正在上传中,-1：上传失败需要重新上传
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"fileUploadStatus": 1
    }
}

下载音视频文件

接口说明
下载音视频文件
URL
/openApi/getFileDownloading.dcw
HTTP请求方式
POST
请求参数
get
非json格式

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
uploadPath String 是 无 文件上传时获取（文件路径）（必填）
nmsName String 是 无 设备编号（必填）
fileType String 是 无 文件类型（必填）2：视频,4：音频
返回值样例：
返回的数据是文件流。

停止播放媒体回放

接口说明及错误码
停止播放媒体回放
URL
/openApi/stopHistoryMedia.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssesionId string 是 无 会话ID（必填，放头部header）
nmsName string 是 无 设备编号（必填）
videoId string 是 无 视频id，从播放媒体回放音视频接口获取，用于关闭（唯一标识）（必填）
返回参数
参数名 说明 描述
code 状态码 200表示成功
msg 消息
data 数据体
errorcode 关闭媒体回放视频状态码 0：成功
videoId 视频id 用于关闭播放的视频
返回示例
{
"code": 200,
"msg": "成功",
"data": {
"error": {
"errorcode": "0",
"errormsg": "",
"data": null
        },
"userId": null,
"videoId": "72210853",
"address": null,
"url": null,
"urlIn": null
    }
}

图片查询

接口说明及错误码
图片查询
URL
/openApi/findImgInfoList.dcw?jssesionId=cf6b70a3c82b43928ab6bbddce336222&termSn=075500000100
HTTP请求方式
GET/POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 否 无 设备编号
vin string 否 无 车牌号或员工编号。设备编号为空时，根据车牌号或员工编号
startTime string 是 无 开始时间
endTime string 是 无 结束时间
page number 否 无 当前页码
pageSize number 否 无 每页记录条数
操作实例
返回参数
参数名 参数类型 描述
id number 图片编号
imgPath string 图片路径
createDate string 创建时间
fileSize string 图片大小
fileName string 文件名
propertyInfo string 图片属性
description string 图片描述
termSn string 设备编号
channelName string 通道名称
channel number 通道编号
result number 返回0则表示请求成功
imgList array 图片列表
page number 当前页码
pageSize number 每页所显示条数
totalPage number 总页码数
totalRecords number 记录条数
返回示例
   {
      {
      "return":"0",
      "imgList":"",
      "page":"0",
      "pageSize":"10",
      "totalPage":"20",
      "totalRecords":"200",

      }
  }

设备管理

增加设备

接口说明及错误码
增加设备
URL
/openApi/saveDevices.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
nmsAlias string 是 无 设备别名
nmsName string 是 无 设备编号
typeId number 是 无 设备类型ID(通过设备类型接口获取)
modelId number 是 无 设备型号ID(通过设备型号接口获取)
departId string 是 无 组织机构ID(通过获取组织机构接口获取)
dataChannelNum number 是 1 通道数目
nmsAgreementType number 是 1 协议类型:
1：JT/T808/1078
3：GB/T28181-2016)
sipId number 是 无 国标设备ID（用于选择国标协议时）
sipTransType number 是 0 通信方式：
用于选择国标协议时
0：UDP
1：TCP
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

编辑设备

接口说明及错误码
编辑设备
URL
/openApi/editDevices.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn String 是 无 设备内部号，修改以这个为唯一
nmsName string 是 无 设备编号，这个不允许修改，只要在修改的时候把值带入就行
nmsAlias string 是 无 设备名称
nmsAgreementType string 是 无 协议类型
nmsStatus string 是 无 设备状态
userTypeId number 是 无 使用场景类型
departId number 是 无 组织名称
modelId number 是 无 设备型号
typeId number 是 无 设备类型
channelList classList 是 无 设备通道列表，查询设备的时候会返回这个值，参数示例:
[{"id":null,"termSn":"100000000008","channelNo":"1","name":"通道9"}]
id：通道ID，如果增加新的，则填null,否则就填设备列表返回的值
termSn：设备内部号
channelNo：通道编号
name：通道名称
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

删除设备

接口说明及错误码
删除设备
URL
/openApi/delDevices.dcw?termSn=075500000100
HTTP请求方式
GET/POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 是 无 设备编号
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": null
}

获取设备类型列表

接口说明及错误码
增加设备
URL
/openApi/getDevicesTypeList.dcw
HTTP请求方式
GET
输入参数说明

（1）私有参数

jssessionId string 是 无 会话ID（必填，放头部header）
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
chName String 类型名称
id Integer 设备类型id
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "id": 1,
            "chName": "BWC",
            "egName": "BWC",
            "remark": "",
            "createTime": null,
            "updateTime": null
        }
}

获取设备型号列表

接口说明及错误码
增加设备
URL
/openApi/getDevicesModelList.dcw
HTTP请求方式
GET
输入参数说明

（1）私有参数

jssessionId string 是 无 会话ID（必填，放头部header）
deviceTypeId Integer 是 无 设备类型id
请求示例
/openApi/getDevicesModelList.dcw?deviceTypeId=1
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
id Integer 设备型号id
modelName String 型号名称
modelCode String 型号编码
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "id": 1,
            "modelName": "DSJ-V6",
            "modelCode": "DSJ-V6",
            "remark": "BWC",
            "nmsTypeId": 1,
            "createTime": null,
            "updateTime": 1616567214000
        }
}

说明：文件列表接口中返回的uploadServerIp字段即为后续接口需要传的ftpId。

获取文件列表

接口说明及错误码
获取文件列表
URL
/openApi/searchMediaPlayBackFileList.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssessionId string 是 无 会话ID（必填，放头部header）
termSnStr string 是 无 TermSn在获取设备信息接口中的TermSn字段返回（可多个，用,分开），如：100000000009。注：只有查询服务器端时可输入多个，其他只能查询单个
startTime date 查询设备端时必填 无 开始时间
endTime date 查询设备端时必填 无 结束时间
uploadStartTime date 否 无 上传开始时间（只用于查询服务器端）
uploadEndTime date 否 无 上传结束时间（只用于查询服务器端）
channel Integer 否 -999 通道
source Integer 是 无 数据来源 1：设备端 2：服务器端
type Integer 是 无 0：录像 4 录音 5：图片（可查询多个，用英文,分割。设备端查询时只支持查询单个类型）
fileRemark String 否 无 文件备注
page String 是 无 当前页码
rows String 是 无 每页条数
操作实例
返回参数
参数名 参数类型 描述
nmsName String 设备名称
termSn String 设备号
fileType Integer 文件类型 0：录像 4 录音 5：图片
fileName String 文件名
filePath String 文件路径
channel Integer 通道
fileSize Integer 文件大小
uploadServerIp Integer FTP
playFilePath String 播放地址
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "pageNum": 1,
        "pageSize": 1,
        "totalRecord": 11,
        "totalPage": 11,
        "list": [
            {
                "id": 904,
                "nmsName": "860301100011585",
                "termSn": "100000000005",
                "fileStatus": 1,
                "fileType": 0,
                "uploadTime": "2022-06-09 16:29:24",
                "startTime": "2022-06-09 16:22:34",
                "endTime": "2022-06-09 16:23:52",
                "fileSize": 41830230,
                "bindingName": "860301100011585",
                "isBinded": 0,
                "nmsAlias": "860301100011585",
                "deptName": "调度中心",
                "fileName": "860301100011585_860301100011585_1_20220609162234.mp4",
                "filePath": "ddzx/860301100011585/Video/2022-06-09/860301100011585_860301100011585_1_20220609162234.mp4",
                "fileDir": null,
                "channel": 1,
                "storageLocation": "服务器端",
                "locationStatus": 2,
                "uploadServerIp": 1,
                "uploadStatus": null,
                "playFilePath": "/openApi/playServerFile.dcw?termSn=100000000005&filePath=ddzx/860301100011585/Video/2022-06-09/860301100011585_860301100011585_1_20220609162234.mp4&fileType=0&ftpId=1",
                "shootingTime": null,
                "imgEndTime": null,
                "fileRemark": null,
                "startTimeStr": null,
                "endTimeStr": null,
                "trackNum": "null"
            }
        ],
        "start": 1,
        "end": 5,
        "fromIndex": 0,
        "toIndex": 1
    }
}

删除文件

接口说明及错误码
删除文件
URL
/openApi/delServerFile.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssessionId string 是 无 会话ID（必填，放头部header）
filePath string 是 无 文件地址
fileType string 是 无 文件类型
id string 是 无 文件ID
返回参数
参数名 参数类型 描述
code number 返回200则表示请求成功
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {}
}

下载文件

接口说明及错误码
下载文件
URL
/openApi/fileDownloading.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssessionId string 是 用户登录返回的会话号
nmsName string 是 无 设备名称
uploadPath string 是 无 文件路径
fileType Integer 是 无 文件类型 0：录像 4 录音 5：图片
操作实例
返回参数
参数名 参数类型 描述
返回示例

播放文件

接口说明及错误码
播放文件
URL
/openApi/playServerFile.dcw?termSn=100000000005&filePath=ddzx/860301100011585/Video/2022-06-09/860301100011585_860301100011585_1_20220609162234.mp4&fileType=0&ftpId=1
HTTP请求方式
GET
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
termSn string 是 无 设备号
filePath string 是 无 文件路径
fileType Integer 是 无 文件类型 1：图片 2：视频 4：音频
ftpId string 是 无 FTP，即列表返回的 uploadServerIp 字段
操作实例
返回参数
参数名 参数类型 描述
返回示例

报警记录列表

接口说明及错误码
报警记录列表
URL
/openApi/getAlarmStatisticsPage.dcw
HTTP请求方式
POST
输入参数说明

（1）私有参数

参数名 参数类型 是否必需 默认值 描述
jssessionId string 是 用户登录返回的会话号
startTime date 否 无 开始时间
endTime date 否 无 结束时间
deptId Integer 否 无 部门ID
termSns string 否 无 设备号，可传多个用英文逗号分隔
alarmType string 否 无 报警类型
page string 否 无 当前页码
rows string 否 无 每页条数
操作实例
返回参数
参数名 参数类型 描述
nmsName String 设备名称
nmsAlias String 设备编号
deptName String 部门名称
alarmDsc String 报警类型
startTime date 报警时间
返回示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "page": 1,
        "pageSize": 1,
        "orderBy": null,
        "order": "ASC",
        "rows": [
            {
                "id": null,
                "termSn": "100000000008",
                "vid": null,
                "vin": null,
                "departId": null,
                "departName": null,
                "alarmCategory": null,
                "status": 2,
                "alarmType": "0",
                "alarmSrc": null,
                "sensorType": null,
                "alarmDsc": "紧急报警",
                "areaId": null,
                "areaName": null,
                "areaType": null,
                "startTime": 1648546043000,
                "endTime": 1648546043000,
                "minSpeed": "0.000",
                "maxSpeed": "0.000",
                "totalSpeed": "0.000",
                "dealMan": null,
                "dealTime": null,
                "dealDescription": null,
                "dealStatus": null,
                "count": 1,
                "alarmData": "",
                "deptId": 1,
                "deptName": "调度中心",
                "bindingId": null,
                "bindingName": "860301100011197",
                "alarmCount": null,
                "alarmDetailDsc": null,
                "nmsName": "860301100011197",
                "isBinded": 0,
                "nmsAlias": "860301100011197"
            }
        ],
        "records": 107,
        "autoCount": false,
        "start": 0,
        "total": 107,
        "pageSizeEnabled": true,
        "previousEnabled": false,
        "nextEnabled": true,
        "startEnabled": true,
        "totalEnabled": true,
        "orderEnabled": false,
        "inverseOrder": "DESC",
        "asc": true
    }
}

PTZ云台控制说明

nPTZCommand取值 功能
12 光圈变大
13 光圈变小
14 停止光圈控制
20 镜头放大
21 镜头缩小
22 停止镜头缩放
30 云台上仰
31 云台下仰
32 云台左转
33 云台右转
34 停止云台转动
62 焦距变远
63 焦距变短
64 停止聚焦控制
70 打开灯光
71 关闭灯光
80 打开雨刷
81 关闭雨刷
120 设置预置点
121 清除预置点
122 调用
123 清除所有
124 自动归位

报警类型表

编号 报警类型
0 紧急报警
1 超速报警
2 疲劳驾驶报警
3 危险预警
4 GNSS 模块发生故障
5 GNNS天线未接
6 GNSS天线短路
7 终端电源欠压
8 终端电源掉电
9 终端显示器故障
10 TTS故障
11 摄像头故障
12 道路运输证IC卡模块故障
13 超速预警
14 疲劳驾驶预警
18 驾驶超时报警
19 停车超时报警
20 进出区域报警
21 进出路线报警
22 路段行驶时间不足/过长
23 路线偏移报警
24 车辆vss故障
25 车辆油量报警
26 车辆被盗报警
27 车辆非法点火
28 车辆非法位移
29 碰撞预警
30 侧翻预警
31 非法开门报警
32 视频信号丢失报警
33 主存储器故障报警
34 灾备存储单元故障报警
35 其他视频设备故障报警
36 客车超载报警
37 异常驾驶行为报警
38 特殊报警录像达到存储阈值报警
39 视频信号遮挡报警
101 GPS信号丢失
102 设备故障
103 视频丢失
104 硬盘故障
105 I/O
106 移动侦测告警
107 SD1故障
108 SD2故障
109 日流量提醒
110 月流量提醒
201 进区域
202 路线偏离
203 分段限速
204 关键点
205 出区域
-1 正常
-2 其他报警类型