设备管理

1、查询设备列表

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/list

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
productId否number产品id
pageIndex否number当前页码，默认1
pageRows否number每页数量，默认20

返回结果

正确的Json返回结果：

{
    "data": {
      "list": [{
      "devId":"2342432423423423432",
      "physicalAddr":"xxxxxx",
      "deviceName": "CC13653",
      "onlineStatus":1,
      "createTime":"2015-06-11 06:00:03"
      "activeTime":"2015-06-11 06:00:03"
      "productId": 114,
      "productIcon": "http://200.200.200.50/v1/device/icon",
      "productName": "威力洗衣机",
      "productCode": "CC-1004",
      "routeDevId": "xxxxxx"
      }],
      "pager": {
          "currPageRows": 1,
          "defaultPageRows": 20,
          "hasNextPage": false,
          "hasPrevPage": false,
          "pageEndRow": 9,
          "pageIndex": 1,
          "pageRows": 10,
          "pageStartRow": 0,
          "paged": false,
          "totalPages": 1,
          "totalRows": 1
      }
    },
    "code": 0
}
字段名称字段类型字段说明
devIdstring设备唯一标识
physicalAddrstring物理地址
deviceNamestring设备名称
onlineStatusnumber在离线状态：1-在线；2-离线
createTimestring创建时间
activeTimestring激活时间
productIdnumber产品id
productIconstring产品图标
productNamestring产品名称
productCodestring产品编码
routeDevIdstring子设备对应的网关设备id

2、查询设备信息

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/info

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识，支持批量查询，以英文逗号分隔，最大限制20

返回结果

正确的Json返回结果：

{
    "data": [{
        "devId":"2342432423423423432",
        "physicalAddr":"xxxxxx",
        "deviceName": "CC13653",
        "onlineStatus":1,
        "createTime":"2015-06-11 06:00:03"
        "activeTime":"2015-06-11 06:00:03"
        "productId": 114,
        "productIcon": "http://200.200.200.50/v1/device/icon",
        "productName": "威力洗衣机",
        "productCode": "CC-1004",
        "routeDevId": "xxxxxx",
        "lastOnlineTime": "2024-05-10 08:24:56",
        "lastOfflineTime": "2024-05-10 08:21:12",
        "deviceVersionList": [{
            "extVersion": "1.0.0.0",
            "firmwareVersionType": 0,
            }]
    }],
    "code": 0
}
字段名称字段类型字段说明
devIdstring设备唯一标识
physicalAddrstring物理地址
deviceNamestring设备名称
onlineStatusnumber在离线状态：1-在线；2-离线
createTimestring创建时间
activeTimestring激活时间
productIdnumber产品id
productIconstring产品图标
productNamestring产品名称
productCodestring产品编码
routeDevIdstring子设备对应的网关设备id
lastOnlineTimestring最后上线时间
lastOfflineTimestring最后离线时间
extVersionstring当前软件版本号
firmwareVersionTypenumber模块编号

3、查询设备绑定信息

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/bind/info

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识

返回结果

正确的Json返回结果：

{
    "data": {
        "bindStatus":"1"
    },
    "code": 0
}
字段名称字段类型字段说明
bindStatusnumber绑定状态：0-未绑定；1-已绑定

4、查询设备数据

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/data/get

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识
type否number老协议：1-运行数据；2-控制数据；3-故障数据；4-配置数据，新协议：无需填写

返回结果

正确的Json返回结果：

{
    "data": {
        "timehour": 0, 
        "reservation": 0, 
        "timemin": 16, 
        "power": 2
    },
    "code": 0
}
字段名称字段类型字段说明
dataobject设备数据

5、查询设备历史数据

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/data/history/get

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识
type否number老协议：1-运行数据；2-控制数据；3-故障数据；4-配置数据，新协议：无需填写
dataTimestamp否number查询数据时间戳，每次查询20条，再次查询可用返回记录的最后一条时间戳继续查询，仅限查询3天内的数据。查询的起始时间需要减去时区之后再转换为时间戳，例如要查询的是北京时间2024-05-01 00:00:00，则先将时间转为为北京时间2024-04-30 16:00:00，再转为时间戳1714464000000。

返回结果

正确的Json返回结果：

{
    "data": [
        {
            "datatimestamp": 1617242556599,
            "base_null_status_null": 3
        },
        {
            "datatimestamp": 1617242556623,
            "base_null_status_null": 3
        }
    ],
    "code": 0
}
字段名称字段类型字段说明
dataobject设备数据

6、设备控制

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/control/set

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识
json是string下发指令

返回结果

正确的Json返回结果：

{
"code": 0
}

7、查询产品列表

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/product/list

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
pageIndex否number当前页码，默认1
pageRows否number每页数量，默认20

返回结果

正确的Json返回结果：

{
    "data": {
      "list": [{
        "productId": 114,
        "productIcon": "http://200.200.200.50/v1/device/icon",
        "productName": "威力洗衣机",
        "productCode": "CC-1004",
        "moduleName": "ESP-WROOM-02"
      }],
      "pager": {
          "currPageRows": 2,
          "defaultPageRows": 20,
          "hasNextPage": false,
          "hasPrevPage": false,
          "pageEndRow": 9,
          "pageIndex": 1,
          "pageRows": 10,
          "pageStartRow": 0,
          "paged": false,
          "totalPages": 1,
          "totalRows": 2
      }
    },
    "code": 0
}
字段名称字段类型字段说明
productIdnumber产品id
productIconstring产品图标
productNamestring产品名称
productCodenumber产品编码
moduleNamestring模块名称

8、查询产品信息

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/product/info

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
productId是number产品id

返回结果

正确的Json返回结果：

{
"data": {
"productId": 114,
"productIcon": "http://200.200.200.50/v1/device/icon",
"productName": "威力洗衣机",
"productCode": "CC-1004",
"moduleName": "ESP-WROOM-02"
},
"code": 0
}
字段名称字段类型字段说明
productIdnumber产品id
productIconstring产品图标
productNamestring产品名称
productCodenumber产品编码
moduleNamestring模块名称

9、网关最新固件版本

根据网关Id获取网关最新固件版本

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/gw/plugin/product

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
productId是number产品id

返回结果

正确的Json返回结果：

{
    "data": {
        "createTime": "2023-01-14 13:56:19",
        "id": 1585,
        "name": "杭研测试1.2.5",
        "packageName": "杭研测试1.2.5",
        "path": "https://skintest.hetyj.com/31438/c16acc93290b4d51351a38793f46b485.zip",
        "pkgMd5": "37982D75C5A6F889FF59B33E25647FE8",
        "status": 1,
        "version": "1.2.5"
    },
    "code": 0
}
字段名称字段类型字段说明
idnumber固件版本表唯一键
namestring固件名称
packageNamestring固件标志
pathstring固件地址
createTimestring创建时间
pkgMd5string插件md5
statusnumber状态 1：已上传 2：已上架 3：已下架
versionstring版本
descstring插件介绍

10、售后中心设备信息维护

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/after/sale/device/addOneDeviceInfo

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
macAddress是string设备MAC地址
productId是number产品id
province否string设备安装地址-省/直辖市
city否string设备安装地址-地级市
county否string设备安装地址-区/县
street否string设备安装地址-街道/乡/镇
detailedAddress否string位置模型,格式: 城阳养老院-A栋-3层-302室
localServiceMan否string现场维护人员
serviceManPhone否string维护人员联系方式
user否string设备使用人

返回结果

正确的Json返回结果：

{
    "msg": "成功",
    "code": 0
}
字段名称字段类型字段说明
codenumber响应状态码:0成功,其他失败

11、查询设备绑定列表

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/bind/list

密钥类型：仅支持项目密钥

参数说明

参数名称是否必须字段类型参数说明
queryType是number查询条件类型（1-设备创建时间；2-设备激活时间；3-设备绑定时间）
queryTime是string查询时间（格式：yyyy-MM-dd HH:mm:ss）
productIds否number产品id列表（以逗号分隔）
pageIndex否number当前页码，默认1
pageRows否number每页数量，默认20

返回结果

正确的Json返回结果：

{
    "data": {
      "list": [{
      "devId":"2342432423423423432",
      "physicalAddr":"xxxxxx",
      "deviceName": "CC13653",
      "createTime":"2015-06-11 06:00:03"
      "activeTime":"2015-06-11 06:00:03"
      "bindTime":"2015-06-11 06:00:03"
      "productId": 114,
      "routeDevId": "xxxxxx",
      "routePhysicalAddr": "xxxxxx"
      }],
      "pager": {
          "currPageRows": 1,
          "defaultPageRows": 20,
          "hasNextPage": false,
          "hasPrevPage": false,
          "pageEndRow": 9,
          "pageIndex": 1,
          "pageRows": 10,
          "pageStartRow": 0,
          "paged": false,
          "totalPages": 1,
          "totalRows": 1
      }
    },
    "code": 0
}
字段名称字段类型字段说明
devIdstring设备唯一标识
physicalAddrstring物理地址
deviceNamestring设备名称
createTimestring创建时间
activeTimestring激活时间
bindTimestring绑定时间
productIdnumber产品id
routeDevIdstring子设备对应的网关设备id
routePhysicalAddrstring子设备对应的网关设备物理地址

12、设备解绑

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/unbind

密钥类型：同时支持用户密钥和项目密钥

单次解绑一个设备时，默认是同步机制，如果采用批量解绑，则采用异步机制，实际的解绑结果可通过数据订阅或查询接口获取

参数说明

参数名称是否必须字段类型参数说明
productId是number产品ID
physicalAddr是string设备物理地址，支持批量，用英文逗号分隔，最大批次50
physicUnbind否number是否物理解绑，0：非物理解绑；1：物理解绑

返回结果

正确的Json返回结果：

{
"code": 0
}
字段名称字段类型字段说明

13、设备日志查询

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/log/getDeviceLogByPage

密钥类型：同时支持用户密钥和项目密钥

参数说明

参数名称是否必须字段类型参数说明
startTime是string开始时间
endTime是string结束时间
key是string关键字搜索
deviceId是string设备id
pageIndex否number当前页码，默认1
pageRows否number每页数量，默认20

返回结果

正确的Json返回结果：

{
	    "data": {
	        "list": [
	            {
	                "did": 0,
	                "eventType": "设备上线",
	                "eventName": "事件名称",
	                "eventDetail": "1",
	                "executeTime": "2021-09-22 09:22:00",
	                "eventStatus": "1",
	                "dpName": "AAAAA",
	                "firmVersion": "11745",
	                "userId": 1,
	                "source": "AAAAAAAAAAAI",
	                "macAddress": 3,
	                "physicalAddr": 1,
	                "imei": "AAAAAAAAAAAI",
	                "tranceId": "1"
	            }
	        ],
	        "pager": {
	            "currPageRows": 5,
	            "defaultPageRows": 20,
	            "hasNextPage": true,
	            "hasPrevPage": false,
	            "pageEndRow": 4,
	            "pageIndex": 1,
	            "pageRows": 5,
	            "pageStartRow": 0,
	            "paged": false,
	            "totalPages": 2,
	            "totalRows": 6
	        }
	    },
	    "code": 0
	}
字段名称字段类型字段说明
did string 设备id
eventType string 设备事件
eventName string 事件名称
eventDetail string 事件详情
executeTime date 执行时间
eventStatus string 事件执行结果 1成功 2失败
dpName string DP功能点名称 设备控制/上报事件
firmVersion string 固件版本号
userId number App用户id
source string 来源(发起端) 设备本身、云端、APP、第三方语音平台
macAddress string 设备mac
physicalAddr String 物理地址
imei string imei
tranceId string 日志链id

14、设备用户关系

http请求方式: POST

https://iot-cloudapi.clife.cn/v5x/open/api/device/bind/relation

密钥类型：同时支持用户密钥和项目密钥

根据设备devId查询设备与第三方账号的授权关系

参数说明

参数名称是否必须字段类型参数说明
devId是string设备唯一标识
type是number第三方登录类型
appId是number应用标识，第三方登录对应的APP

返回结果

正确的Json返回结果：

{
"code": 0,
"data": [
        {
            "thirdId": "193BADC86D2FB8FACF107728BBA43635",
            "share": 2,
            "authTime": "2016-04-11 09:42:01"
        }
    ]
}
字段名称字段类型字段说明
thirdIdstring第三方账号ID
sharenumber设备分享（1-分享，2-绑定）
authTimenumber授权时间