X-Link API 文档-V4.0.0 | X-Link API 文档-V4.0.0

终端参数

部标终端参数设置与查询,包括视频相关的参数

获取终端参数

接口信息

请求地址: /web_api/v1/dev_manage/get_dev_param

请求类型: GET

Content-Type:x-www-form-urlencoded

请求参数

字段	类型	必选	说明
vehicleNo	string	是	车牌号
paramIDs	string	否	参数ID列表,空表示查所有,查询多个用逗号隔开

响应Data (类型:array(object))

定义查看表1:参数信息

示例

请求示例

url

http://localhost:8080/web_api/v1/dev_manage/get_dev_param?vehicleNo=130000000001&paramIDs=1,16

http://localhost:8080/web_api/v1/dev_manage/get_dev_param?vehicleNo=130000000001&paramIDs=1,16

响应示例

json

{
    "code": 200,
    "msg": "成功",
    "data": [{
        "paramID": 1,   //终端心跳发送间隔
        "paramType": 2 , //4个字节整型
        "paramContent": "60" //所有的paramContent 都是整型
    },{
        "paramID": 16, //主服务器APN
        "paramType": 3 , //string
        "paramContent": "127.0.0.1"
    }]
}

{
    "code": 200,
    "msg": "成功",
    "data": [{
        "paramID": 1,   //终端心跳发送间隔
        "paramType": 2 , //4个字节整型
        "paramContent": "60" //所有的paramContent 都是整型
    },{
        "paramID": 16, //主服务器APN
        "paramType": 3 , //string
        "paramContent": "127.0.0.1"
    }]
}

设置终端参数

接口信息

请求地址: /web_api/v1/dev_manage/set_dev_param

请求类型: POST

Content-Type:application/json

请求参数

名称	类型	必选	说明
vehicleNos	array(string)	是	车牌号列表
items	array(object)	是	参数信息,查看当前页表1

响应Data

无

示例

请求示例

json

http://localhost:8080/web_api/v1/dev_manage/set_dev_param
{
    "vehicleNos": ["130000001"],
    "items": [{
        "paramID": 1,
        "paramType": 2,
        "paramContent":"70"
    },{
        "paramID": 117, // 音视频参数
        "paramType": 4 , //json object string
        "paramContent": "{\"enableAudio\":1,\"rtCodecMode\":0,\"rtResolution\":1,\"rtKeyFrameInteval\":12,\"rtTargetFrameRate\":6,\"rtTargetBitRate\":200,\"stCodecMode\":0,\"stResolution\":5,\"stKeyFrameInteval\":30,\"stTargetFrameRate\":15,\"stTargetBitRate\":1200,\"osd\":11}"
    }]
}

http://localhost:8080/web_api/v1/dev_manage/set_dev_param
{
    "vehicleNos": ["130000001"],
    "items": [{
        "paramID": 1,
        "paramType": 2,
        "paramContent":"70"
    },{
        "paramID": 117, // 音视频参数
        "paramType": 4 , //json object string
        "paramContent": "{\"enableAudio\":1,\"rtCodecMode\":0,\"rtResolution\":1,\"rtKeyFrameInteval\":12,\"rtTargetFrameRate\":6,\"rtTargetBitRate\":200,\"stCodecMode\":0,\"stResolution\":5,\"stKeyFrameInteval\":30,\"stTargetFrameRate\":15,\"stTargetBitRate\":1200,\"osd\":11}"
    }]
}

响应示例

json

{
    "hdr":{
        "code":200,
        "message":"success"
    },"data":["130000001"]
}

{
    "hdr":{
        "code":200,
        "message":"success"
    },"data":["130000001"]
}

表1: 参数信息

字段	类型	说明
paramID	integer	参数ID,查看当前页面表2,视频的参考表3
paramType	integer	参数类型,0:byte(字节);1:integer2(2个字节整型);2:integer4(4个字节整型);3:string(字符串);4:stringObject(json字符串)
paramContent	string	参数内容,具体查看类型ID后面的说明

表2: JT808 参数ID定义

参数ID	参数类型	内容说明
1	integer4	终端心跳发送间隔,单位为秒
2	integer4	TCP 消息应答超时时间,单位为秒
3	integer4	TCP 消息重传次数
4	integer4	UDP 消息应答超时时间,单位为秒
5	integer4	UDP 消息重传次数
6	integer4	SMS消息应答超时时间,单位为秒
7	integer4	SMS消息重传次数
16	string	主服务器APN
17	string	主服务器用户
18	string	主服务器无线通信拨号密码
19	string	主服务器地址
20	string	备份服务器APN
21	string	备服务器用户
22	string	备服务器无线通信拨号密码
23	string	备服务器地址
24	integer4	服务器 TCP 端口
25	integer4	服务器 UDP 端口
26	string	IC 卡认证主服务器地址
27	integer4	道路运输证 IC 卡认证主服务器 TCP 端口
28	integer4	道路运输证 IC 卡认证主服务器 UDP 端口
29	string	IC 卡认证备份服务器
32	integer4	位置汇报策略
33	integer4	位置汇报方案
34	integer4	驾驶员未登录汇报时间间隔,单位为秒（s）,>0
39	integer4	休眠时汇报时间间隔，单位为秒（s），>0
40	integer4	紧急报警时汇报时间间隔，单位为秒（s），>0
41	integer4	缺省时间汇报间隔，单位为秒（s），>0
44	integer4	缺省距离汇报间隔，单位为米（m），>0
45	integer4	驾驶员未登录汇报距离间隔，单位为米（m），>0
46	integer4	休眠时汇报距离间隔，单位为米（m），>0
47	integer4	紧急报警时汇报距离间隔，单位为米（m），>0
48	integer4	拐点补传角度
49	integer2	电子围栏半径单位为米
64	string	监控平台电话号码
65	string	复位电话号码，可采用此电话号码拨打终端电话让终端复位
66	string	恢复出厂设置电话号码
67	string	监控平台 SMS 电话号码
68	string	接收终端 SMS 文本报警号码
69	integer4	接听策略,0:自动接听;1:ACC ON时自动接听,OFF时手动接听
70	integer4	每次最长通话时间,单位为秒 0 为不允许通话
71	integer4	每次最短通话时间，单位为秒，0 为不允许通话
72	string	监听电话号码
73	string	监管平台特权短信号码
80	integer4	报警屏蔽字
81	integer4	报警发送文本 SMS 开关
82	integer4	报警拍摄开关
83	integer4	报警拍摄存储标志
84	integer4	关键标志
85	integer4	最高速度,单位为公里每小时（km/h）
86	integer4	超速持续时间,单位为秒（s）
87	integer4	连续驾驶时间门限,单位为秒（s）
88	integer4	当天累计驾驶时间门限,单位为秒（s）
89	integer4	最小休息时间,单位为秒（s）
90	integer4	最长停车时间,单位为秒（s）
91	integer2	超速报警预警差值,单位为 1/10Km/h
92	integer2	疲劳驾驶预警差值,单位为秒（s），>0
93	integer2	碰撞:bit0-7:时间ms,8-15:加速度0.1g,范围在:0-79之间,默认为10
94	integer2	侧翻报警参数设置：侧翻角度，单位 1 度，默认为 30 度。
100	integer4	定时拍照控制
101	integer4	定距拍照控制
112	integer4	图像/视频质量，1-10，1 最好
113	integer4	亮度，0-255
114	integer4	对比度，0-127
115	integer4	饱和度，0-127
116	integer4	色度，0-255
128	integer4	车辆里程表读数，1/10km
129	integer2	车辆所在的省域 ID
130	integer2	车辆所在的市域 ID
131	string	公安交通管理部门颁发的机动车号牌
132	byte	车牌颜色，按照 JT/T415-2006 的 5.4.12
144	byte	GNSS 定位模式
145	byte	GNSS 波特率
146	byte	GNSS 模块详细定位数据输出频率
147	integer4	GNSS 模块详细定位数据采集频率，单位为秒，默认为 1。
148	byte	GNSS 模块详细定位数据上传方式
149	integer4	GNSS 模块详细定位数据上传设置
256	integer4	CAN 总线通道 1 采集时间间隔(ms)，0 表示不采集
257	integer2	CAN 总线通道 1 上传时间间隔(s)，0 表示不上传
258	integer4	CAN 总线通道 2 采集时间间隔(ms)，0 表示不采集
259	integer2	CAN 总线通道 2 上传时间间隔(s)，0 表示不上传

表3: JT1078 视频相关参数ID定义

参数ID	参数类型	内容说明
117	stringObject	音视频参数设置,paramContent是一个json 字符串,查看当前页表4
118	stringObject	音视频通道列表设置,paramContent是一个json 字符串,查看当前页表5
119	stringObject	单独视频通道设置,paramContent是一个json 字符串,查看当前页表6

表4: 音视频参数设置定义(object)

字段	类型	说明
enableAudio	integer	是否启用音频输出,0:否,1:是
rtCodecMode	integer	实时编码模式 0:CBR(固主码率);1:VBR(可变码率);2:ABR(平均码率)
rtResolution	integer	实时分辨率 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
rtKeyFrameInteval	integer	实时关键帧间隔范围(1000)帧
rtTargetFrameRate	integer	目标帧率范围(1-120)帧/s
rtTargetBitRate	integer	目标码率单位为千位每秒(kbps)
stCodecMode	integer	存储编码模式 0:CBR(固主码率); 1:VBR(可变码率); 2:ABR(平均码率)
stResolution	integer	存储分辨率 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
stKeyFrameInteval	integer	存储关键帧间隔范围(1000)帧
stTargetFrameRate	integer	存储目标帧率范围(1-120)帧/s
stTargetBitRate	integer	存储目标码率单位为千位每秒(kbps)
osd	integer	字幕叠加,按位:bit0:日期时间,1:车牌号码;2:逻辑通道号;3.经纬度;4:行驶速度;5:定位速度;6:连续驾驶时间

表5: 音视频通道列表设置

字段	类型	说明
audioVideoCnt	integer	音视频数量
audioCnt	integer	音频数量
videoCnt	integer	视频数量
list	array(object)	通道信息,参考以下表定义

通道信息

字段	类型	说明
physicsChannelNo	integer	物理通道号,从0开始
logicChannelNo	integer	逻辑通道,参考其它页面的公共定义表2
chType	integer	通道类型,0:音视频;1:音频;2:视频
isConnectPTZ	integer	是否连接云台,通道类型为0,2时有效

表6: 单独视频通道设置

字段	类型	说明
item	array(object)	单独通道设置的列表,单独通道信息定义查看以下表

单独通道信息

字段	类型	说明
channelNo	integer	单独设置的逻辑通道号
rtCodecMode	integer	实时编码模式 0:CBR(固主码率);1:VBR(可变码率);2:ABR(平均码率)
rtResolution	integer	实时分辨率 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
rtKeyFrameInteval	integer	实时关键帧间隔范围(1000)帧
rtTargetFrameRate	integer	目标帧率范围(1-120)帧/s
rtTargetBitRate	integer	目标码率单位为千位每秒(kbps)
stCodecMode	integer	存储编码模式 0:CBR(固主码率); 1:VBR(可变码率); 2:ABR(平均码率)
stResolution	integer	存储分辨率 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
stKeyFrameInteval	integer	存储关键帧间隔范围(1000)帧
stTargetFrameRate	integer	存储目标帧率范围(1-120)帧/s
stTargetBitRate	integer	存储目标码率单位为千位每秒(kbps)
osd	integer	字幕叠加,按位:bit0:日期时间,1:车牌号码;2:逻辑通道号;3.经纬度;4:行驶速度;5:定位速度;6:连续驾驶时间

开始使用

请求应答类

推送类

实时流

历史流

终端参数

获取终端参数

请求地址: /web_api/v1/dev_manage/get_dev_param

请求类型: GET

Content-Type:x-www-form-urlencoded

请求参数

响应Data (类型:array(object))

示例

请求示例

响应示例

设置终端参数

请求地址: /web_api/v1/dev_manage/set_dev_param

请求类型: POST

Content-Type:application/json

请求参数

响应Data

示例

请求示例

响应示例

表1: 参数信息

表2: JT808 参数ID定义

表3: JT1078 视频相关参数ID定义

表4: 音视频参数设置定义(object)

表5: 音视频通道列表设置

通道信息

表6: 单独视频通道设置

单独通道信息

终端参数 ​

获取终端参数 ​

请求地址: /web_api/v1/dev_manage/get_dev_param ​

请求类型: GET ​

Content-Type:x-www-form-urlencoded ​

请求参数 ​

响应Data (类型:array(object)) ​

示例 ​

请求示例 ​

响应示例 ​

设置终端参数 ​

请求地址: /web_api/v1/dev_manage/set_dev_param ​

请求类型: POST ​

Content-Type:application/json ​

请求参数 ​

响应Data ​

示例 ​

请求示例 ​

响应示例 ​

表1: 参数信息 ​

表2: JT808 参数ID定义 ​

表3: JT1078 视频相关参数ID定义 ​

表4: 音视频参数设置定义(object) ​

表5: 音视频通道列表设置 ​

通道信息 ​

表6: 单独视频通道设置 ​

单独通道信息 ​

终端参数

获取终端参数

请求地址: /web_api/v1/dev_manage/get_dev_param

请求类型: GET

Content-Type:x-www-form-urlencoded

请求参数

响应Data (类型:array(object))

示例

请求示例

响应示例

设置终端参数

请求地址: /web_api/v1/dev_manage/set_dev_param

请求类型: POST

Content-Type:application/json

请求参数

响应Data

示例

请求示例

响应示例

表1: 参数信息

表2: JT808 参数ID定义

表3: JT1078 视频相关参数ID定义

表4: 音视频参数设置定义(object)

表5: 音视频通道列表设置

通道信息

表6: 单独视频通道设置

单独通道信息