調用該接口根據過濾規則,從客戶端通過本地通訊發現的本地設備列表中過濾出還未被用戶綁定的設備信息。

路徑 /awss/enrollee/product/filter
版本號 1.0.9
協議 HTTP,HTTPS
請求方法 POST
是否需要用戶身份鑒權
超時時間 15000

請求參數

名稱 類型 是否必選 示例值 描述
iotDevices List [{"productKey":"pk1","deviceName":"dn1"},{"productKey":"pk2","deviceName":"dn2"}] 本地發現的設備信息列表。
productKey String a1h****aDXE 產品的Key,設備證書信息之一。創建產品時,生活物聯網平臺為該產品頒發的全局唯一標識。
deviceName String 23FS90G****GJWWEGR 設備的名稱,設備證書信息之一。在注冊設備時,自定義的或系統生成的設備名稱,具備產品維度內的唯一性。
reset Boolean reset標記。true(不過濾已經綁定的該設備);false(過濾已經綁定的該設備)。
productId String 1234 表示產品的全球唯一id,類比于productKey藍牙配網的時候可以傳此參數過濾。
productStatusEnv String release 產品狀態。dev(表示產品開發中);release(表示產品已發布)。

返回數據

名稱 類型 示例值 描述
code Int

接口返回碼。200表示成功。

message String

調用失敗時,返回的出錯信息。

localizedMsg String

本地語言的錯誤信息。

data JSON

返回的產品信息。

productKey String

產品的Key。

deviceName String

設備名稱。

token String

設備上傳的生活物聯網平臺Token。

productName String

產品名稱。

netType Int

產品入網類型:0(表示LoRa);3(表示WiFi);4(表示ZigBee);5(表示Bluetooth);6(表示蜂窩網);7(表示以太網);8(表示其他入網方式)。

nodeType Int

節點類型。0(表示設備);1(表示網關)。

categoryKey String

產品所屬品類的品類標識符。

categoryName String

產品所屬品類的名稱。

categoryId Long

產品歸屬品類的ID。

image String

產品圖標URL。

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.9",
		"iotToken": "token"
	},
	"params":{
		"iotDevices":[
			{
				"productKey": "pk1",
				"deviceName": "dn1"
			},
			{
				"productKey": "pk2",
				"deviceName": "dn2"
			}
		],
		"productStatusEnv": "release"
	}
}

正常返回示例

JSON格式

{
    "code": 200,
    "data":[{
                "productKey":"a1v12d****",
                "deviceName":"xxxxxx",
                "netType":3,
                "nodeType":0,
                "categoryKey":"xxx",
                "categoryName":"xxx",
                "categoryId":14
            }
    ],
    "message": "success"
}

異常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "請求被禁止",
    "data": null
}