跳到主要内容
版本:3.4.0

终端指令集成接口参数、应答通知

本篇文档主要描述企业应用采用网关对接方式时涉及的指令,以及这些指令的以下两种结构:

  • 指令参数的结构(即TermCmd中的params属性的结构)
  • 指令状态变更通知CmdStateChanged的ackParams属性的结构

指令一览表

指令所属协议指令消息号指令名称必要
JT/T 8088201查询位置信息可选 1
JT/T 10789101音视频传输请求必要
JT/T 10789102音视频实时传输控制必要
JT/T 10789201远程录像回放请求必要
JT/T 10789202远程录像回放控制必要
JT/T 10789205查询资源列表可选 2
JT/T 10789206录像文件上传指令可选 3
JT/T 10789207录像文件上传控制可选 3
T/GDRTA, T/SCSDX, T/JSATL等9208报警附件上传指令可选 4
JT/T 10789301云台旋转可选 5
JT/T 10789302云台调整焦距控制可选 5
JT/T 10789303云台调整光圈控制可选 5
JT/T 10789304云台雨刷控制可选 5
JT/T 10789305红外补光控制可选 5
JT/T 10789306云台变倍控制可选 5
1: 此指令用于调试工具程序( https://wx.gratour.info:3001/ )检查终端是否在线,可选实现。

2: 不实现时,接口GET /strm/stored将不可用,企业应用应另行提供接口供客户端调用。

3: 不实现时,接口POST /strm/stored/uploadPOST /strm/stored/upload/ctrl将不可用,接口GET /strm/stored/upload将返回空结果, 企业应用应另行提供接口供客户端调用。

4: 不实现时,报警附件提取功能将不可用,企业应用应另行提供接口供客户端调用。

5: 不实现时,指令接口POST /term_cmd对应的指令将不可用,企业应用应另行提供接口供客户端调用。


位置信息查询 (8201)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
nullQryLocationAckParams5

QryLocationAckParams

属性数据类型必要说明
trkTrkY轨迹数据

指令数据体示例

{
"msgId": "8201",
"simNo": "13320200317"
}

应答通知数据体示例

{
"id": "433350002",
"reqTm": 1643006473800,
"status": 2,
"tm": 1643006473802,
"initMsgId": "8201",
"simNo": "13320200317",
"ackMsgId": "0201",
"ackSeqNo": 3,
"ackParams": {
"trk": {
"simNo": "13320200317",
"recvTm": 1643006473802,
"gpsTm": 1643006473000,
"alm": 0,
"st": 524291,
"lng": 121.42949,
"lat": 31.24088,
"alt": 10,
"spd": 30.0,
"recSpd": 30.0,
"dir": 0
}
}
}

音视频传输请求 (9101)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9101_LiveAvReqnull30

CP_9101_LiveAvReq

属性数据类型必要说明
serverIpstringY服务器IP
tcpPortintYTCP端口号
udpPortintYUDP端口号
chanintY终端音视频逻辑通道号
dataTypint数据类型:
  • 0: 音视频
  • 1: 视频
  • 2:双向对讲
  • 3:监听
  • 4: 中心广播(暂不支持)
  • 5: 透传(暂不支持)
不指定时,视为0
codeStrmint码流类型:
  • 0: 主码流
  • 1: 子码流
不指定时,视为0

指令数据体示例

{
"msgId": "9101",
"simNo": "13320200317",
"params": {
"serverIp": "113.89.33.219",
"tcpPort": 9000,
"udpPort": 0,
"chan": 1,
"dataTyp": 0,
"codeStrm": 1
}
}

音视频实时传输控制 (9102)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9102_LiveAvCtrlnull8

CP_9102_LiveAvCtrl

属性数据类型必要说明
chanintY终端音视频逻辑通道号
ctrlintY控制命令:
  • 0: 关闭音视频传输
  • 1: 切换码流
  • 2: 暂停流
  • 3: 恢复流
  • 4: 关闭双向对讲
closeActionint关闭动作:
  • 0: 关闭音视频
  • 1: 仅关闭音频
  • 2: 仅关闭视频
仅当ctrl==0时有效
codeStrmint新的码流类型:
  • 0: 主码流
  • 1: 子码流
仅当ctrl==1时有效

指令数据体示例

{
"msgId": "9102",
"simNo": "13320200317",
"params": {
"chan": 1,
"ctrl": 0,
"closeAction": 0
}
}

远程录像回放请求 (9201)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9201_ReplayAvReqnull30

CP_9201_ReplayAvReq

属性数据类型必要说明
serverIpstringY服务器IP
tcpPortintYTCP端口号
udpPortintYUDP端口号
chanintY终端音视频逻辑通道号
mediaTypintY音视频资源类型:
  • 0: 音、视频
  • 1: 音频
  • 2: 视频
  • 3: 视频或音频。
codeStrmintY码流类型:
  • 0: 所有码流
  • 1: 主码流
  • 2: 子码流。
如果此通道只传输音频,应设为0
stgTypintY存储器类型:
  • 0: 所有存储器
  • 1: 主存储器
  • 2: 灾备存储器。
modeint回放方式:
0: 正常回放
1: 快进回放
2: 关键帧快退回放
3: 关键帧播放
4: 单帧上传

未指定时,默认为:0
factorint快进或快退倍数:
  • 0: 无效
  • 1: 1倍
  • 2: 2倍
  • 3: 4倍
  • 4: 8倍
  • 5: 16倍
回放方式(mode)为12时,此属性有效,否则为0。未指定时默认为0
startTmlongY开始时间,Epoch milli-seconds。回放方式(mode)为4时,该字段表示单帧上传时间
endTmlong结束时间,Epoch milli-seconds。不指定此属性,或为0时,表示一直回放。回放方式(mode)为4时,该属性无效1
1:部分终端存在指定结束时间为0时,指令不执行也不应答的情况。

指令数据体示例

{
"msgId": "9201",
"simNo": "13320200317",
"params": {
"serverIp": "113.89.33.219",
"tcpPort": 9000,
"udpPort": 0,
"chan": 1,
"mediaTyp": 0,
"codeStrm": 0,
"stgTyp": 0,
"mode": 0,
"startTm": 1599107148000
}
}

远程录像回放控制 (9202)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9202_ReplayAvCtrlnull8

CP_9202_ReplayAvCtrl

属性数据类型必要说明
chanintY终端音视频逻辑通道号
ctrlintY控制命令:
  • 0: 开始回放
  • 1: 暂停回放
  • 2: 结束回放
  • 3: 快进回放
  • 4: 关键帧快退回放
  • 5: 拖动回放
  • 6: 关键帧播放
factorint快进或快退倍数:
  • 1: 1倍
  • 2: 2倍
  • 3: 4倍
  • 4: 8倍
  • 5: 16倍
ctrl == 3ctrl == 4时,此属性有效
timelong拖动回放的时间点,Epoch millis-seconds, 仅当ctrl==5时有效

指令数据体示例

{
"msgId": "9202",
"simNo": "13320200317",
"params": {
"chan": 1,
"ctrl": 3,
"factor": 2
}
}

查询资源列表 (9205)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9205_QryAvResnull15

CP_9205_QryAvRes

属性数据类型必要说明
chanintY终端音视频逻辑通道号
startTmlong录像文件的开始记录时间,Epoch milli-seconds。不指定本属性,或为0时,表示不指定结束记录时间。注1
endTmlong录像文件的结束记录时间,Epoch milli-seconds。不指定本属性,或为0时,表示不指定结束记录时间。注1
almFilter808intJT808 32位报警标志,不指定时,默认为0
almFilter1078intJT1078 32位报警标志,不指定时,默认为0
mediaTypintY音视频资源类型:
  • 0: 音、视频
  • 1: 音频
  • 2: 视频
  • 3: 视频或音频。
codeStrmintY码流类型:
  • 0: 所有码流
  • 1: 主码流
  • 2: 子码流。
stgTypintY存储器类型:
  • 0: 所有存储器
  • 1: 主存储器
  • 2: 灾备存储器。

指令数据体示例

{
"msgId": "9205",
"simNo": "13320200317",
"params": {
"chan": 1,
"startTm": 1599091200000,
"mediaTyp": 0,
"codeStrm": 0,
"stgTyp": 0
}
}

录像文件上传指令 (9206)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9206_AvUploadReqnull15

CP_9206_AvUploadReq

属性数据类型必要说明
ftpHoststringYFTP服务器主机地址
ftpPortintYFTP服务端口
ftpUserstringYFTP登录名1
ftpPwdstringYFTP登录密码
uploadPathstringY文件上传路径
chanintY上传通道
startTmlongY录像的开始时间,Epoch milli-seconds
endTmlongY录像的结束时间,Epoch milli-seconds
almFilter808int报警类型过滤中JT808报警标志,不提供本属性时,视为0。参见JT808-2013协议文本中的表24
almFilter1078int报警类型过滤中JT1078报警标志,不提供本属性时,视为0。参见JT1078-2016协议文本中的表14
mediaTypintY音视频资源类型:
  • 0: 音视频
  • 1: 音频
  • 2: 视频
  • 3: 音频或视频
codeStrmintY码流类型:
  • 0: 所有码流
  • 1: 主码流
  • 2: 子码流
stgTypintY存储位置:
  • 0: 所有存储位置
  • 1: 主存储器
  • 2: 灾备存储器
未指定时默认为0
whenintY上传操作的执行条件,以位掩码表示,参见以下when位掩码
1: 服务端可能产生一次性的FTP用户名和密码,企业应用不应缓存此用户名和密码

when位掩码

位序号置位时表示
0有WIFI连接时可下载
1有LAN连接时可下载
2有移动连接时可下载

指令数据体示例

{
"msgId": "9206",
"simNo": "13320200317",
"params": {
"ftpHost": "113.89.33.219",
"ftpPort": 10021,
"ftpUser": "av-upload-1",
"ftpPwd": "FK1FPdp6B8FoPnrx",
"uploadPath": "/2020/09/03/13320200317/lg9R227z7IIb3Esi",
"chan": 1,
"startTm": 1599128410000,
"endTm": 1599129507000,
"mediaTyp": 0,
"codeStrm": 1,
"stgTyp": 1,
"when": 7
}
}

录像文件上传控制 (9207)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9207_AvUploadCtrlnull8

CP_9207_AvUploadCtrl

属性数据类型必要说明
origSeqNointY应答流水号。对应录像文件上传指令(9206)的消息流水号
ctrlintY控制动作:
  • 0: 暂停
  • 1: 继续
  • 2: 取消

指令数据体示例

{
"msgId": "9206",
"simNo": "13320200317",
"params": {
"origSeqNo": 121,
"ctrl": 2
}
}

报警附件上传指令 (9208)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9208_AlmAddtUploadReqnull8

CP_9208_AlmAddtUploadReq

属性数据类型必要说明
serverIpstringY附件服务器IP地址
tcpPortintY使用TCP端口号
udpPortintY使用UDP端口号
almNostringY终端报警标识号,HEX编码
almIdstringY平台报警编号

指令数据体示例

{
"msgId": "9208",
"simNo": "13320200317",
"params": {
"serverIp": "113.89.33.219",
"tcpPort": 8000,
"udpPort": 0,
"almNo": "36373131333133000000000000000000000000000000000000000000000021110906584000050000",
"almId": "14323_1599129507000"
}
}

云台旋转 (9301)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9301_PtzTurnnull5

CP_9301_PtzTurn

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY方向:
  • 0: 停止
  • 1: 上
  • 2: 下
  • 3: 左
  • 4: 右
spdintY速度。0-255

云台调用焦距控制 (9302)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9302_PtzFocusingnull5

CP_9302_PtzFocusing

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY焦距调整方向:
  • 0: 焦距调大
  • 1: 焦距调小

云台调整光圈控制 (9303)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9303_PtzIrisCtrlnull5

CP_9303_PtzIrisCtrl

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY光圈调整方式:
  • 0: 调大
  • 1: 调小

云台雨刷控制 (9304)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9304_PtzWiperCtrlnull5

CP_9304_PtzWiperCtrl

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY启停标识:
  • 0: 停止
  • 1: 启动

红外补光控制 (9305)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9305_PtzFillLightCtrlnull5

CP_9305_PtzFillLightCtrl

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY启停标识:
  • 0: 停止
  • 1: 启动

云台变倍控制 (9306)

下发参数(params)数据类型终端指令应答通知(ackParams)数据类型默认指令超时(秒)
CP_9306_PtzZoomCtrlnull5

CP_9306_PtzZoomCtrl

属性数据类型必要说明
chanintY逻辑通道号
ctrlintY变倍控制:
  • 0: 调大
  • 1: 调小