版本：1.1.7

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

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

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

指令一览表

指令所属协议	指令消息号	指令名称	必要
JT/T 808	8201	查询位置信息	可选 ¹
JT/T 1078	9101	音视频传输请求	必要
JT/T 1078	9102	音视频实时传输控制	必要
JT/T 1078	9201	远程录像回放请求	必要
JT/T 1078	9202	远程录像回放控制	必要
JT/T 1078	9205	查询资源列表	可选 ²
JT/T 1078	9206	录像文件上传指令	可选 ³
JT/T 1078	9207	录像文件上传控制	可选 ³
T/GDRTA, T/SCSDX, T/JSATL等	9208	报警附件上传指令	可选 ⁴
JT/T 1078	9301	云台旋转	可选 ⁵
JT/T 1078	9302	云台调整焦距控制	可选 ⁵
JT/T 1078	9303	云台调整光圈控制	可选 ⁵
JT/T 1078	9304	云台雨刷控制	可选 ⁵
JT/T 1078	9305	红外补光控制	可选 ⁵
JT/T 1078	9306	云台变倍控制	可选 ⁵

注¹: 此指令用于调试工具程序( https://n11.gratour.info:3001/ )检查终端是否在线，可选实现。

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

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

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

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

位置信息查询 (8201)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
`null`	QryLocationAckParams	5

QryLocationAckParams

属性	数据类型	必要	说明
trk	Trk	Y	轨迹数据

指令数据体示例

{
  "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_LiveAvReq	`null`	30

CP_9101_LiveAvReq

属性	数据类型	必要	说明
serverIp	string	Y	服务器IP
tcpPort	int	Y	TCP端口号
udpPort	int	Y	UDP端口号
chan	int	Y	终端音视频逻辑通道号
dataTyp	int		数据类型： `0`: 音视频 `1`: 视频 `2`:双向对讲 `3`:监听 `4`: 中心广播(暂不支持) `5`: 透传(暂不支持) 不指定时，视为`0`
codeStrm	int		码流类型： `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_LiveAvCtrl	`null`	8

CP_9102_LiveAvCtrl

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

指令数据体示例

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

远程录像回放请求 (9201)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9201_ReplayAvReq	`null`	30

CP_9201_ReplayAvReq

属性	数据类型	必要	说明
serverIp	string	Y	服务器IP
tcpPort	int	Y	TCP端口号
udpPort	int	Y	UDP端口号
chan	int	Y	终端音视频逻辑通道号
mediaTyp	int	Y	音视频资源类型： `0`: 音、视频 `1`: 音频 `2`: 视频 `3`: 视频或音频。
codeStrm	int	Y	码流类型： `0`: 所有码流 `1`: 主码流 `2`: 子码流。如果此通道只传输音频，应设为`0`
stgTyp	int	Y	存储器类型： `0`: 所有存储器 `1`: 主存储器 `2`: 灾备存储器。
mode	int		回放方式： `0`: 正常回放 `1`: 快进回放 `2`: 关键帧快退回放 `3`: 关键帧播放 `4`: 单帧上传未指定时，默认为：`0`
factor	int		快进或快退倍数： `0`: 无效 `1`: 1倍 `2`: 2倍 `3`: 4倍 `4`: 8倍 `5`: 16倍回放方式(`mode`)为`1`和`2`时，此属性有效，否则为`0`。未指定时默认为`0`
startTm	long	Y	开始时间，Epoch milli-seconds。回放方式(`mode`)为`4`时，该字段表示单帧上传时间
endTm	long		结束时间，Epoch milli-seconds。不指定此属性，或为`0`时，表示一直回放。回放方式(`mode`)为`4`时，该属性无效¹

注¹：部分终端存在指定结束时间为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_ReplayAvCtrl	`null`	8

CP_9202_ReplayAvCtrl

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

指令数据体示例

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

查询资源列表 (9205)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9205_QryAvRes	`null`	15

CP_9205_QryAvRes

属性	数据类型	必要	说明
chan	int	Y	终端音视频逻辑通道号
startTm	long		录像文件的开始记录时间，Epoch milli-seconds。不指定本属性，或为0时，表示不指定结束记录时间。注¹
endTm	long		录像文件的结束记录时间，Epoch milli-seconds。不指定本属性，或为0时，表示不指定结束记录时间。注¹
almFilter808	int		JT808 32位报警标志，不指定时，默认为`0`
almFilter1078	int		JT1078 32位报警标志，不指定时，默认为`0`
mediaTyp	int	Y	音视频资源类型： `0`: 音、视频 `1`: 音频 `2`: 视频 `3`: 视频或音频。
codeStrm	int	Y	码流类型： `0`: 所有码流 `1`: 主码流 `2`: 子码流。
stgTyp	int	Y	存储器类型： `0`: 所有存储器 `1`: 主存储器 `2`: 灾备存储器。

指令数据体示例

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

录像文件上传指令 (9206)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9206_AvUploadReq	`null`	15

CP_9206_AvUploadReq

属性	数据类型	必要	说明
ftpHost	string	Y	FTP服务器主机地址
ftpPort	int	Y	FTP服务端口
ftpUser	string	Y	FTP登录名¹
ftpPwd	string	Y	FTP登录密码
uploadPath	string	Y	文件上传路径
chan	int	Y	上传通道
startTm	long	Y	录像的开始时间，Epoch milli-seconds
endTm	long	Y	录像的结束时间，Epoch milli-seconds
almFilter808	int		报警类型过滤中JT808报警标志，不提供本属性时，视为`0`。参见JT808-2013协议文本中的表24
almFilter1078	int		报警类型过滤中JT1078报警标志，不提供本属性时，视为`0`。参见JT1078-2016协议文本中的表14
mediaTyp	int	Y	音视频资源类型： `0`: 音视频 `1`: 音频 `2`: 视频 `3`: 音频或视频
codeStrm	int	Y	码流类型： `0`: 所有码流 `1`: 主码流 `2`: 子码流
stgTyp	int	Y	存储位置： `0`: 所有存储位置 `1`: 主存储器 `2`: 灾备存储器未指定时默认为`0`
when	int	Y	上传操作的执行条件，以位掩码表示，参见以下`when`位掩码

注¹: 服务端可能产生一次性的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_AvUploadCtrl	`null`	8

CP_9207_AvUploadCtrl

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

指令数据体示例

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

报警附件上传指令 (9208)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9208_AlmAddtUploadReq	`null`	8

CP_9208_AlmAddtUploadReq

属性	数据类型	必要	说明
serverIp	string	Y	附件服务器IP地址
tcpPort	int	Y	使用TCP端口号
udpPort	int	Y	使用UDP端口号
almNo	string	Y	终端报警标识号，HEX编码
almId	string	Y	平台报警编号

指令数据体示例

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

云台旋转 (9301)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9301_PtzTurn	`null`	5

CP_9301_PtzTurn

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	方向： `0`: 停止 `1`: 上 `2`: 下 `3`: 左 `4`: 右
spd	int	Y	速度。0-255

云台调用焦距控制 (9302)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9302_PtzFocusing	`null`	5

CP_9302_PtzFocusing

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	焦距调整方向： `0`: 焦距调大 `1`: 焦距调小

云台调整光圈控制 (9303)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9303_PtzIrisCtrl	`null`	5

CP_9303_PtzIrisCtrl

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	光圈调整方式： `0`: 调大 `1`: 调小

云台雨刷控制 (9304)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9304_PtzWiperCtrl	`null`	5

CP_9304_PtzWiperCtrl

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	启停标识： `0`: 停止 `1`: 启动

红外补光控制 (9305)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9305_PtzFillLightCtrl	`null`	5

CP_9305_PtzFillLightCtrl

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	启停标识： `0`: 停止 `1`: 启动

云台变倍控制 (9306)

下发参数(params)数据类型	终端指令应答通知(ackParams)数据类型	默认指令超时（秒）
CP_9306_PtzZoomCtrl	`null`	5

CP_9306_PtzZoomCtrl

属性	数据类型	必要	说明
chan	int	Y	逻辑通道号
ctrl	int	Y	变倍控制： `0`: 调大 `1`: 调小

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

指令一览表​

位置信息查询 (8201)​

QryLocationAckParams​

指令数据体示例​

应答通知数据体示例​

音视频传输请求 (9101)​

CP_9101_LiveAvReq​

指令数据体示例​

音视频实时传输控制 （9102）​

CP_9102_LiveAvCtrl​

指令数据体示例​

远程录像回放请求 (9201)​

CP_9201_ReplayAvReq​

指令数据体示例​

远程录像回放控制 (9202)​

CP_9202_ReplayAvCtrl​

指令数据体示例​

查询资源列表 (9205)​

CP_9205_QryAvRes​

指令数据体示例​

录像文件上传指令 (9206)​

CP_9206_AvUploadReq​

when位掩码​

指令数据体示例​

录像文件上传控制 (9207)​

CP_9207_AvUploadCtrl​

指令数据体示例​

报警附件上传指令 (9208)​

CP_9208_AlmAddtUploadReq​

指令数据体示例​

云台旋转 (9301)​

CP_9301_PtzTurn​

云台调用焦距控制 (9302)​

CP_9302_PtzFocusing​

云台调整光圈控制 (9303)​

CP_9303_PtzIrisCtrl​

云台雨刷控制 (9304)​

CP_9304_PtzWiperCtrl​

红外补光控制 (9305)​

CP_9305_PtzFillLightCtrl​

云台变倍控制 (9306)​

CP_9306_PtzZoomCtrl​

指令一览表

位置信息查询 (8201)

QryLocationAckParams

指令数据体示例

应答通知数据体示例

音视频传输请求 (9101)

CP_9101_LiveAvReq

指令数据体示例

音视频实时传输控制（9102）

CP_9102_LiveAvCtrl

指令数据体示例

远程录像回放请求 (9201)

CP_9201_ReplayAvReq

指令数据体示例

远程录像回放控制 (9202)

CP_9202_ReplayAvCtrl

指令数据体示例

查询资源列表 (9205)

CP_9205_QryAvRes

指令数据体示例

录像文件上传指令 (9206)

CP_9206_AvUploadReq

`when`位掩码

指令数据体示例

录像文件上传控制 (9207)

CP_9207_AvUploadCtrl

指令数据体示例

报警附件上传指令 (9208)

CP_9208_AlmAddtUploadReq

指令数据体示例

云台旋转 (9301)

CP_9301_PtzTurn

云台调用焦距控制 (9302)

CP_9302_PtzFocusing

云台调整光圈控制 (9303)

CP_9303_PtzIrisCtrl

云台雨刷控制 (9304)

CP_9304_PtzWiperCtrl

红外补光控制 (9305)

CP_9305_PtzFillLightCtrl

云台变倍控制 (9306)

CP_9306_PtzZoomCtrl