設備管理

1、查詢設備列表

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
productId	否	number	産品id
pageIndex	否	number	當前頁碼，默認1
pageRows	否	number	每頁數量，默認20

返回結果

正确的(of)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	設備唯一(one)标識
physicalAddr	string	物理地(land)址
deviceName	string	設備名稱
onlineStatus	number	在(exist)離線狀态：1-在(exist)線；2-離線
createTime	string	創建時(hour)間
activeTime	string	激活時(hour)間
productId	number	産品id
productIcon	string	産品圖标
productName	string	産品名稱
productCode	string	産品編碼
routeDevId	string	子設備對應的(of)網關設備id

2、查詢設備信息

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識，支持批量查詢，以(by)英文逗号分隔，最大(big)限制20

返回結果

正确的(of)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	設備唯一(one)标識
physicalAddr	string	物理地(land)址
deviceName	string	設備名稱
onlineStatus	number	在(exist)離線狀态：1-在(exist)線；2-離線
createTime	string	創建時(hour)間
activeTime	string	激活時(hour)間
productId	number	産品id
productIcon	string	産品圖标
productName	string	産品名稱
productCode	string	産品編碼
routeDevId	string	子設備對應的(of)網關設備id
lastOnlineTime	string	最後上線時(hour)間
lastOfflineTime	string	最後離線時(hour)間
extVersion	string	當前軟件版本号
firmwareVersionType	number	模塊編号

3、查詢設備綁定信息

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識

返回結果

正确的(of)Json返回結果：

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

字段名稱	字段類型	字段說明
bindStatus	number	綁定狀态：0-未綁定；1-已綁定

4、查詢設備數據

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識
type	否	number	老協議：1-運行數據；2-控制數據；3-故障數據；4-配置數據，新協議：無需填寫

返回結果

正确的(of)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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識
type	否	number	老協議：1-運行數據；2-控制數據；3-故障數據；4-配置數據，新協議：無需填寫
dataTimestamp	否	number	查詢數據時(hour)間戳，每次查詢20條，再次查詢可用(use)返回記錄的(of)最後一(one)條時(hour)間戳繼續查詢，僅限查詢3天内的(of)數據

返回結果

正确的(of)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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識
json	是(yes)	string	下發指令

返回結果

正确的(of)Json返回結果：

{
"code": 0
}

7、查詢産品列表

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
pageIndex	否	number	當前頁碼，默認1
pageRows	否	number	每頁數量，默認20

返回結果

正确的(of)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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
productId	是(yes)	number	産品id

返回結果

正确的(of)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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
productId	是(yes)	number	産品id

返回結果

正确的(of)Json返回結果：

{
    "data": {
        "createTime": "2023-01-14 13:56:19",
        "id": 1585,
        "name": "杭研測試1.2.5",
        "packageName": "杭研測試1.2.5",
        "path": "static/file/yanglao.1603261618138",
        "pkgMd5": "37982D75C5A6F889FF59B33E25647FE8",
        "status": 1,
        "version": "1.2.5"
    },
    "code": 0
}

字段名稱	字段類型	字段說明
id	number	固件版本表唯一(one)鍵
name	string	固件名稱
packageName	string	固件标志
path	string	固件地(land)址
createTime	string	創建時(hour)間
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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
macAddress	是(yes)	string	設備MAC地(land)址
productId	是(yes)	number	産品id
province	否	string	設備安裝地(land)址-省/直轄市
city	否	string	設備安裝地(land)址-地(land)級市
county	否	string	設備安裝地(land)址-區/縣
street	否	string	設備安裝地(land)址-街道/鄉/鎮
detailedAddress	否	string	位置模型,格式: 城陽養老院-A棟-3層-302室
localServiceMan	否	string	現場維護人(people)員
serviceManPhone	否	string	維護人(people)員聯系方式
user	否	string	設備使用(use)人(people)

返回結果

正确的(of)Json返回結果：

{
    "msg": "成功",
    "code": 0
}

字段名稱	字段類型	字段說明
code	number	響應狀态碼:0成功,其他(he)失敗

11、查詢設備綁定列表

http請求方式: POST

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

密鑰類型：僅支持項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
queryType	是(yes)	number	查詢條件類型（1-設備創建時(hour)間；2-設備激活時(hour)間；3-設備綁定時(hour)間）
queryTime	是(yes)	string	查詢時(hour)間（格式：yyyy-MM-dd HH:mm:ss）
productIds	否	number	産品id列表（以(by)逗号分隔）
pageIndex	否	number	當前頁碼，默認1
pageRows	否	number	每頁數量，默認20

返回結果

正确的(of)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	設備唯一(one)标識
physicalAddr	string	物理地(land)址
deviceName	string	設備名稱
createTime	string	創建時(hour)間
activeTime	string	激活時(hour)間
bindTime	string	綁定時(hour)間
productId	number	産品id
routeDevId	string	子設備對應的(of)網關設備id
routePhysicalAddr	string	子設備對應的(of)網關設備物理地(land)址

12、設備解綁

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

單次解綁一(one)個(indivual)設備時(hour)，默認是(yes)同步機制，如果采用(use)批量解綁，則采用(use)異步機制，實際的(of)解綁結果可通過數據訂閱或查詢接口獲取

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
productId	是(yes)	number	産品ID
physicalAddr	是(yes)	string	設備物理地(land)址，支持批量，用(use)英文逗号分隔，最大(big)批次50
physicUnbind	否	number	是(yes)否物理解綁，0：非物理解綁；1：物理解綁

返回結果

正确的(of)Json返回結果：

{
"code": 0
}

字段名稱	字段類型	字段說明

13、設備日志查詢

http請求方式: POST

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

密鑰類型：同時(hour)支持用(use)戶密鑰和(and)項目密鑰

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
startTime	是(yes)	string	開始時(hour)間
endTime	是(yes)	string	結束時(hour)間
key	是(yes)	string	關鍵字搜索
deviceId	是(yes)	string	設備id
pageIndex	否	number	當前頁碼，默認1
pageRows	否	number	每頁數量，默認20

返回結果

正确的(of)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	執行時(hour)間
eventStatus	string	事件執行結果 1成功 2失敗
dpName	string	DP功能點名稱 設備控制/上報事件
firmVersion	string	固件版本号
userId	number	App用(use)戶id
source	string	來(Come)源(發起端) 設備本身、雲端、APP、第三方語音平台
macAddress	string	設備mac
physicalAddr	String	物理地(land)址
imei	string	imei
tranceId	string	日志鏈id

14、設備用(use)戶關系

http請求方式: POST

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

密鑰類型：僅支持開放平台用(use)戶密鑰

根據設備devId查詢設備與第三方賬号的(of)授權關系

參數說明

參數名稱	是(yes)否必須	字段類型	參數說明
devId	是(yes)	string	設備唯一(one)标識
type	是(yes)	number	第三方登錄類型
appId	是(yes)	number	應用(use)标識，第三方登錄對應的(of)APP

返回結果

正确的(of)Json返回結果：

{
"code": 0,
"data": [
        {
            "thirdId": "193BADC86D2FB8FACF107728BBA43635",
            "share": 2,
            "authTime": "2016-04-11 09:42:01"
        }
    ]
}

字段名稱	字段類型	字段說明
thirdId	string	第三方賬号ID
share	number	設備分享（1-分享，2-綁定）
authTime	number	授權時(hour)間