设备透传接口

该接口用于开发者下发指令到设备,通过该接口可实现设备设置、报警设置和查询等功能。具体协议内容请咨询我公司设备侧对接人

接口调用说明

请求地址 : /v1/api/device/trans_cmd
请求方式 : POST

请求头

参数名 参数值 是否必须
Content-Type application/json
X-Token 实际accessToken

请求报文体

名称 类型 是否必须 备注
deviceSn String 设备序列号
data String 透传请求参数体,设备协议为json格式,需要转成字符串传输
//示例数据
{
    "deviceSn":"**********",
    "data":"{\"method\":\"chnosd_get_param\",\"param\":{\"channelid\":0}}"
}

响应报文

名称 类型 是否必须 备注
code int 状态码
msg String 状态码解释信息
data String 透传响应信息,将内容转为json后就是设备返回的信息
//示例数据
{
    "code": 1000,
    "msg": "OK",
    "data": "{\"method\":\"chnosd_get_param\",\"result\":{\"bShowOSD\":true,\"timeFormat\":\"YYYY-MM-DD hh:mm:ss\",\"position\":\"hide\",\"timePos\":\"left_top\",\"channelName\":\"HD IPC\",\"bOsdInvColEn\":false,\"bLargeOSD\":true},\"error\":{\"errorcode\":0},\"sentcnt\":0}"
}
// data 转化为json后的示例
{
    "method":"chnosd_get_param",
    "result":{
        "bShowOSD":true,
        "timeFormat":"YYYY-MM-DD hh:mm:ss",
        "position":"hide",
        "timePos":"left_top",
        "channelName":"HD IPC",
        "bOsdInvColEn":false,
        "bLargeOSD":true
    },
    "error":{
        "errorcode":0  // 0:表示设备成功返回结果;其他表示错误,具体错误原因咨询设备侧对接人
    },
    "sentcnt":0
}

code错误码

状态码 状态描述
1000 code=1000仅表示与设备通信成功,设备是否成功返回结果需要根据data中的errorcode进行判断
1001 参数格式错误或缺失
1002 请求异常
1006 AccessToken过期或异常
2002 设备不在线
2008 设备不存在

results matching ""

    No results matching ""