设备透传接口

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

接口调用说明

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

请求头

请求报文体

// 示例数据
{
    "data":"{\"method\":\"chnosd_get_param\",\"param\":{\"channelid\":0}}",
    "deviceSn":"XXXXXXXXXXXX"
}

响应报文

//示例数据
{
    "code":1000,//状态码
    "msg":"OK",//状态码解释信息    
    "data":"{\"method\":\"chnosd_get_param\",\"request_id\":\"e08970aa-dfba-43db-bfdb-7c1161bd3321\",\"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}"
}

注意：

1. 该接口的响应报文中的code表示的是服务端的状态码，表示服务端传输成功与否。
2. code = 1000 代表服务端响应成功。
3. 协议中的错误码 errorcode 表示设备是否成功执行指令。
4. errorcode = 0 代表设备执行指令成功，其他代表设备执行指令失败。

设备报错时返回信息示例

原始返回数据

{
    "code": 1000,
    "msg": "OK",
    "data": "{\"method\":\"image_get_ability\",\"request_id\":\"73deb5ed-e6a7-477f-9f08-9b353586f66b\",\"error\":{\"errorcode\":-32004,\"message\":\"Function not support\"},\"sentcnt\":0}"
}

原始数据data参数转化为json

{
    "method": "image_get_ability",
    "request_id": "73deb5ed-e6a7-477f-9f08-9b353586f66b",//可以不用关注
    "error": {
        "errorcode": -32004,//设备返回错误码
        "message": "Function not support"//设备返回的错误描述
    },
    "sentcnt": 0 //不需要关注
}

Shell请求示例

请求示例

curl --location 'https://openapi.cloudsee.com/v1/api/device/trans_cmd' \
--header 'Authorization: Bearer 96d96bab-c341-40bc-87da-be1b4cdd80c7' \
--header 'Content-Type: application/json' \
--data '{
    "deviceSn":"DH1239012312",
    "data":"{\"method\":\"ptz_fi_start\",\"param\":{\"channelid\":0,\"focusFar\":-12,\"irisOpen\":0}}"
}'

返回数据

{
    "code": 1000,
    "message": "success",
    "data": {
        "method": "ptz_move_start",
        "error": {
            "message": "Success",
            "errorcode": 0
        },
        "request_id": "b5ed-e6a7-477f-9f08-9b353586"
    }
}