GET api/Cmd/GetCmdList?Model={Model}&Token={Token}&Language={Language}

获取设备某个型号支持的指令列表 ***主要用于首次集成接口时根据自己使用的设备型号获取对应型号支持的指令,接口文档中非自己型号的指令可以不用集成,如果没有需求的指令集,请联系相关人员申请添加

请求信息

URI 参数

参数名称备注说明数据类型附加信息
Model

设备所属型号 ,可以从设备列表或者其他接口获取到

integer

Required

Token

Token 授权信息,第一次请求时该值为空

string

Required

Language

语言 中文:zh-cn 英文:en-us

string

Required

Body 参数

None.

响应信息

资源描述

GetCmdListResult
参数名称备注说明数据类型附加信息
CmdList

返回该型号设备支持的指令类型集合(即指令文档中的指令编号) 逗号分隔,格式:cmd1,cmd2,cmd3 类型定义 ★1:上传时间间隔 设置参数:"20" 参数说明:20表示上传定位包间隔为20秒 单位:秒 范围:5-9999秒 ★2:立即定位 设置参数:"" 参数说明:无需传递参数值 ★3:重启指令 设置参数:"" 参数说明:无需传递参数值 ★4:超速报警设置 设置参数:"10,120" 参数说明:逗号分隔,10表示超速持续时间为10秒 单位:秒 120表示超速阈值为120 km/h,单位:公里/小时 ★5:拆除报警开关 设置参数:"0" 参数说明:0表示关闭 1表示开启 ★6:定位方式(VT77M专用) 设置参数:"3" 参数说明:1表示基站定位+wifi定位+GPS定位 2表示基站定位+wifi定位 3表示基站定位+GPS定位 ★7:工作模式 (VT99M专用)[上传时间间隔模式 该模式为省电模式,按照设置的时间间隔上传数据]、[连续定位模式 此模式比较耗电,一般用于追车,连续定位30分钟,30分钟之内按照10s上传时间间隔传输,30分钟结束后恢复到上一次的定位模式]、[智能监控模式 此模式耗电量大,为追踪车辆模式,通过检测车辆震动来实现追车,只要设备感应到震动,就会被唤醒上传位置,一直到设备静止才休眠。]、[时间选择模式 深度休眠模式,此模式设备每天固定这个点开机工作规定时间然后关机。] 设置参数:"1,1440" 参数说明:示例1:1,1440 逗号分隔,1表示上传时间间隔(省电模式) 1440表示时间间隔 单位:分钟 范围:30-1440分钟 示例2:2,0 逗号分隔,2表示连续定位模式 0无意义仅占位 示例3:3,0 逗号分隔,3表示智能监控模式 0无意义仅占位 示例4:4,1215|1400|1530 第一个参数逗号分隔 第二个参数|分隔 4表示时间选择模式 1215|1400|1530表示3个时间点 1215表示12点15分 1400表示14点整 1530表示15点30分 ★8:设置震动报警规则 设置参数:"3,3" 参数说明: 逗号分隔,第一个3表示检测时长为3分钟 单位:分钟 第二个3表示检测震动次数为3次 工作说明:设备在多长时间内震动多少次产生震动报警 ★9:寻找设备 设置参数:"" 参数说明:无需传递参数值 工作说明:设备会发出提示声响 ★10:设置定位模式(PT01专用) 设置参数:"1" 参数说明:逗号分隔 1表示基站定位+wifi定位+GPS定位 2表示基站定位+wifi定位 3表示基站定位+GPS定位 ★11:声音开关 设置参数:"1" 参数说明:1表示打开声音 0表示关闭声音 默认:打开声音 ★12:设置工作模式(PT01专用) 设置参数:"0" 参数说明:0表示紧急模式 1表示正常模式A 2表示省电模式 3表示正常模式B ★13:设置定位模式(VT77M专用) 设置参数:"1,10" 参数说明:逗号分隔 示例1:0,30 0表示连续定位省电模式 10表示定位包上报间隔 单位:秒 最小不小于5秒 示例2:1,10 1表示连续定位在线模式 10表示定位包上报间隔 单位:秒 最小不小于5秒 示例3:2,1800 2表示定时省电模式 1800表示定时唤醒上报间隔 单位:秒 最小不小于30分钟(1800秒) ★14:设置定位汇报参数(JT808专用) 设置参数:"0,10,300" 参数说明:逗号分隔 0表示定时汇报(1表示定距汇报) 10表示缺省时间汇报间隔 单位:秒 300表示缺省距离汇报间隔 单位:米 ★15:设置超速参数(JT808专用) 设置参数:"10,120" 参数说明:逗号分隔 10表示超速持续时间 单位:秒 120表示超速持续速度120km/h 单位:公里/小时 ★16:重启设备(JT808专用) 设置参数:"" 参数说明:无需传递参数值 ★17:立即定位 (JT808专用) 设置参数:"" 参数说明:无需传递参数值

string

None.

State

返回值基类 0表示成功返回 -1表示接口异常

integer

None.

Remark

返回值说明 通常用于解释返回值情况,例如:接口成功返回、提交的鉴权信息匹配异常等解释说明 0:接口成功返回 -1:接口返回异常 999:鉴权失败 1:提交的鉴权信息匹配异常 2:提交的Token已过期,请重新获取Token 3:用户不存在 4:暂不支持设备IMEI登录 5:用户名下没有设备存在 6:没有获取到分组信息 7:设备不存在 8:没有获取到该时间段内的轨迹数据 9:没有获取到该设备的报警信息 10:用户不存在或密码不匹配 11:报警信息不存在 12:要删除的电子围栏不存在 13:没有获取到该设备的ACC数据 14:该区域内没有设备存在 15:无法获取到该设备的OBD信息 16:要修改的围栏不属于该设备

string

None.

响应格式

application/json, text/json

Sample:
{
  "CmdList": "sample string 1",
  "State": 2,
  "Remark": "sample string 3"
}

application/xml, text/xml

Sample:
<GetCmdListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenWebAPI.Models.ResModel">
  <Remark>sample string 3</Remark>
  <State>2</State>
  <CmdList>sample string 1</CmdList>
</GetCmdListResult>