设备管理

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
}

字段名称	字段类型	字段说明
devId	string	设备唯一标识
physicalAddr	string	物理地址
deviceName	string	设备名称
onlineStatus	number	在离线状态：1-在线；2-离线
createTime	string	创建时间
activeTime	string	激活时间
productId	number	产品id
productIcon	string	产品图标
productName	string	产品名称
productCode	string	产品编码
routeDevId	string	子设备对应的网关设备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
}

字段名称	字段类型	字段说明
devId	string	设备唯一标识
physicalAddr	string	物理地址
deviceName	string	设备名称
onlineStatus	number	在离线状态：1-在线；2-离线
createTime	string	创建时间
activeTime	string	激活时间
productId	number	产品id
productIcon	string	产品图标
productName	string	产品名称
productCode	string	产品编码
routeDevId	string	子设备对应的网关设备id
lastOnlineTime	string	最后上线时间
lastOfflineTime	string	最后离线时间
extVersion	string	当前软件版本号
firmwareVersionType	number	模块编号

3、查询设备绑定信息

http请求方式: POST

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

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

参数说明

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

返回结果

正确的Json返回结果：

{
    "data": {
        "bindStatus":"1"
    },
    "code": 0
}

字段名称	字段类型	字段说明
bindStatus	number	绑定状态：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
}

字段名称	字段类型	字段说明
data	object	设备数据

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
}

字段名称	字段类型	字段说明
data	object	设备数据

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
}

字段名称	字段类型	字段说明
productId	number	产品id
productIcon	string	产品图标
productName	string	产品名称
productCode	number	产品编码
moduleName	string	模块名称

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
}

字段名称	字段类型	字段说明
productId	number	产品id
productIcon	string	产品图标
productName	string	产品名称
productCode	number	产品编码
moduleName	string	模块名称

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
}

字段名称	字段类型	字段说明
id	number	固件版本表唯一键
name	string	固件名称
packageName	string	固件标志
path	string	固件地址
createTime	string	创建时间
pkgMd5	string	插件md5
status	number	状态 1：已上传 2：已上架 3：已下架
version	string	版本
desc	string	插件介绍

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
}

字段名称	字段类型	字段说明
code	number	响应状态码: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
}

字段名称	字段类型	字段说明
devId	string	设备唯一标识
physicalAddr	string	物理地址
deviceName	string	设备名称
createTime	string	创建时间
activeTime	string	激活时间
bindTime	string	绑定时间
productId	number	产品id
routeDevId	string	子设备对应的网关设备id
routePhysicalAddr	string	子设备对应的网关设备物理地址

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"
        }
    ]
}

字段名称	字段类型	字段说明
thirdId	string	第三方账号ID
share	number	设备分享（1-分享，2-绑定）
authTime	number	授权时间

15、查询设备协议别名

http请求方式: POST

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

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

根据设备devId查询设备协议别名

参数说明

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

返回结果

正确的Json返回结果：

{
"code": 0,
"data": {
            "deviceName": "193BADC86D2FB8FACF107728BBA43635",
            "productIcon": "http://skintest.hetyj.com/31438/ed9c06cea8054821d33c61059a9cea1f.png",
            "identifierAlias": [
                {
                    "identifier": "switchName",
                    "nickName": "22222"
                },
                {
                    "identifier": "switchName2",
                    "nickName": "22888"
                }
            ]
        }
}

字段名称	字段类型	字段说明
deviceName	string	设备名称
productIcon	string	产品图标
identifierAlias	list	协议别名列表

16、查询网关设备信息

http请求方式: POST

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

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

根据子设备devId查询归属网关设备信息

参数说明

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

返回结果

正确的Json返回结果：

{
"code": 0,
"data": {
        "activeTime": "2021-05-24 19:29:04",
        "createTime": "2021-05-24 19:29:04",
        "devId": "803049D6CF1D",
        "deviceName": "ZigBee3.0网关",
        "physicalAddr": "803049D6CF1D",
        "productCode": "ZigBee3.0网关",
        "productIcon": "http://fileserver1.clife.net/group1/M01/DC/1A/Cvtlp114t_uACnrAAAWpMVZjKbc2886732",
        "productId": 7710,
        "productName": "ZigBee3.0网关"
    }
}

字段名称	字段类型	字段说明
devId	string	设备唯一标识
physicalAddr	string	物理地址
deviceName	string	设备名称
createTime	string	创建时间
activeTime	string	激活时间
productId	number	产品id
productIcon	string	产品图标
productCode	string	产品编码
productName	string	产品名称

17、查询子设备列表

http请求方式: POST

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

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

根据网关设备devId查询子设备列表

参数说明

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

返回结果

正确的Json返回结果：

{
"code": 0,
"data": [
        {
            "activeTime": "2021-05-24 19:29:04",
            "createTime": "2021-05-24 19:29:04",
            "devId": "803049D6CF1D",
            "deviceName": "ZigBee3.0网关",
            "physicalAddr": "803049D6CF1D",
            "productCode": "ZigBee3.0网关",
            "productIcon": "http://fileserver1.clife.net/group1/M01/DC/1A/Cvtlp114t_uACnrAAAWpMVZjKbc2886732",
            "productId": 7710,
            "productName": "ZigBee3.0网关"
        }
    ]
}

字段名称	字段类型	字段说明
devId	string	设备唯一标识
physicalAddr	string	物理地址
deviceName	string	设备名称
createTime	string	创建时间
activeTime	string	激活时间
productId	number	产品id
productIcon	string	产品图标
productCode	string	产品编码
productName	string	产品名称