下发终端指令接口
POST /term_cmd
本指令用于向终端下发指令,如位置信息查询(定位)指令、云台指令等。
服务端有一个开放指令号列表设置(配置文件
config/config.json
中的api.enabledTermCmds
属性), 只有这个指令号列表中的指令才可经由本接口下发;如果下发的指令不在指令号列表中,则返回-11: 拒绝访问
错误。 对于如音视频类指令(除了云台指令外)、主动安全附件类指令,应使用相关的接口,由相关接口负责与终端交互,不应直接使用本接口对终端下发指令。指令成功下发后,服务端将跟踪指令;当指令应答时,或下发指令出错时,或指令被取消时,或指令超时时,服务将通过
CmdStateChanged
终端指令应答通知 来通知客户端指令状态的变化。
请求
POST https://n11.gratour.info:8388/v1/term_cmd
Content-Type: application/json
X-Auth-Token: HrWwReOAQ9WdLnJQ1JYivA
{
"msgId": "8201",
"simNo": "13320200317"
}
请求实体属性
属性 | 数据类型 | 必要 | 说明 |
---|---|---|---|
msgId | string | Y | JT/T 808,JT/T 1078 指令消息号,如位置信息查询指令为:8201 |
subCmdTyp | string | 子命令类型。如终端控制的大类型是8105 ,子命令类型是它的命令字。又如下发终端升级包,大类型是8108 ,子命令是它的升级类型 | |
simNo | string | Y | 终端识别号 |
params | object | 参数,以 JSON 对象表示。不同指令的params对象的结构请参考 终端指令参数、应答通知 | |
timeout | int | 超时时长,单位:秒。不指定时或指定为0时,指令将在半小时后超时。小于2的非0值无效 |
应答
{
"data": [
{
"id": "410950043",
"reqTm": 1576031206415,
"status": 0,
"simNo": "13320200317",
"msgId": "8201",
"msgSn": 1289
}
],
"count": 1,
"errCode": 0,
"message": "成功。"
}
应答实体属性
属性 | 数据类型 | 必要 | 说明 |
---|---|---|---|
errCode | int | Y | 错误码。
|
message | string | Y | 错误信息 |
data | array[TermCmd] | 返回的结果对象数组。元素为 TermCmd 类型。主要使用其中的id 属性。 | |
count | int | 返回的记录数 |