查询常用设备列表

接口地址:/v2/family/enduserapi/getCommonUsedDeviceList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

查询常用设备列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
fid	家庭ID	query	true	string
isGroupDeviceShow	是否展示群组：false-不展示群组 true-展示群组	query	false	boolean
page	当前页，默认为第 1 页	query	false	integer(int32)
pageSize	页大小，默认为 10 条	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	查询常用设备列表成功	返回注册码响应数据«PageInfo«查询家庭中设备列表»»
5618	请输入家庭ID
5676	调用产品服务异常

响应参数:

参数名称	参数说明	类型	schema
code	响应状态码	integer(int32)	integer(int32)
data	响应数据	PageInfo«查询家庭中设备列表»	PageInfo«查询家庭中设备列表»
endRow		integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	查询家庭中设备列表
accessType	访问类型：0-直连设备 1-网关设备 2-网关子设备	string
activeTime	激活时间	string
activeTimeTs		integer
aiCapabilityStatus	AI能力开关状态	boolean
authCode	authCode	string
authKey	authKey	string
bindMode	绑定模式：1-多绑模式 2-唯一模式 3-轮流模式	integer
bindStatus	绑定状态：1-正常 2-失效	integer
bindingCode	bindingCode	string
bindingType	绑定类型:1 SN绑定 2 wifi绑定 3 PKDK绑定 4 蓝牙绑定	integer
btLastUseTime	蓝牙最近时间时间（毫秒时间戳）	integer
btPwd	btPwd	string
capabilitiesBitmask	设备联网能力	integer
commonUsed		boolean
deviceBindTime	设备绑定时间	string
deviceBindTimeTs		integer
deviceCreateTime	设备创建时间	string
deviceCreateTimeTs		integer
deviceKey	Device Key	string
deviceName	设备名称	string
deviceStatus	设备状态	string
deviceTag	设备标签	string
deviceType	设备类型：1-自有设备 2-分享来的设备	integer
fid	家庭ID	string
firstItemCode	一级品类code	string
firstItemName	一级品类名称	string
frid	家庭房间ID	string
gdid	群组id	string
groupDeviceDeviceNum	群组设备数	integer
groupState	群组权限	integer
invaildTime	失效时间	string
invaildTimeTs		integer
isCommonUsed	是否常用设备	boolean
isMatter	是否是matter设备，0非 1是	integer
isNative	判断是否是第三方设备，0未知 1移远	integer
lastConnTime	最后上线时间	string
lastConnTimeTs		integer
lastOfflineTime	离线时间	string
lastOfflineTimeTs		integer
locateType	支持的定位内容	string
logoImage	产品logo	string
lowPowerAlive	低功耗心跳周期(分)	integer
lowPowerCache	低功耗缓存时长，单位为秒	integer
lowPowerProduct	是否为低功耗产品 是: true, 否: false	boolean
lowPowerStatus	低功耗状态开关	boolean
matterInfo		BindNativeMatterDto	BindNativeMatterDto
catList		array	CatInfoDto
cat		integer
privilege		string
discriminator		integer
extra		string
fabricId		integer
matterProductId		integer
matterVendorId		integer
matterVersion		string
nodeId		integer
networkType	网络类型：1-wifi 2-蜂窝 3-NB 5-蓝牙	string
onlineStatus	设备在线状态：0-离线 1-在线	integer
ownerUid	分享人用户ID，来自谁的分享	string
phone	已绑定用户手机号	string
planId	升级计划ID	integer
productKey	Product Key	string
productName	产品名称	string
protocol	接入协议	string
roomName	房间名称	string
secondItemCode	二级品类code	string
secondItemName	二级品类名称	string
shareCode	分享码	string
sharingExpireAt	设备使用到期时间	string
sharingExpireTimeTs		integer
signalStrength	信号强度	string
sn		string
status	绑定状态：1-正常 2-失效	integer
type	绑定类型	integer
uid	已绑定用户ID	string
upgradeStatus	设备升级状态	integer
userConfirmStatus	用户确认状态	integer
userName	已绑定用户昵称	string
verified	设备绑定是否认证：0-未认证 1-已认证	string
navigateFirstPage		integer(int32)
navigateLastPage		integer(int32)
navigatePages		integer(int32)
navigatepageNums		array	integer
nextPage		integer(int32)
pageNum		integer(int32)
pageSize		integer(int32)
pages		integer(int32)
prePage		integer(int32)
size		integer(int32)
startRow		integer(int64)
total		integer(int64)
extMsg	扩展消息	string
msg	响应消息	string

响应示例:

{
	"code": 0,
	"data": {
		"endRow": 0,
		"hasNextPage": true,
		"hasPreviousPage": true,
		"isFirstPage": true,
		"isLastPage": true,
		"list": [
			{
				"accessType": "",
				"activeTime": "",
				"activeTimeTs": 0,
				"aiCapabilityStatus": true,
				"authCode": "",
				"authKey": "",
				"bindMode": 0,
				"bindStatus": 0,
				"bindingCode": "",
				"bindingType": 0,
				"btLastUseTime": 0,
				"btPwd": "",
				"capabilitiesBitmask": 0,
				"commonUsed": true,
				"deviceBindTime": "",
				"deviceBindTimeTs": 0,
				"deviceCreateTime": "",
				"deviceCreateTimeTs": 0,
				"deviceKey": "",
				"deviceName": "",
				"deviceStatus": "",
				"deviceTag": "",
				"deviceType": 0,
				"fid": "",
				"firstItemCode": "",
				"firstItemName": "",
				"frid": "",
				"gdid": "",
				"groupDeviceDeviceNum": 0,
				"groupState": 0,
				"invaildTime": "",
				"invaildTimeTs": 0,
				"isCommonUsed": true,
				"isMatter": 0,
				"isNative": 0,
				"lastConnTime": "",
				"lastConnTimeTs": 0,
				"lastOfflineTime": "",
				"lastOfflineTimeTs": 0,
				"locateType": "",
				"logoImage": "",
				"lowPowerAlive": 0,
				"lowPowerCache": 0,
				"lowPowerProduct": true,
				"lowPowerStatus": true,
				"matterInfo": {
					"catList": [
						{
							"cat": 0,
							"privilege": ""
						}
					],
					"discriminator": 0,
					"extra": "",
					"fabricId": 0,
					"matterProductId": 0,
					"matterVendorId": 0,
					"matterVersion": "",
					"nodeId": 0
				},
				"networkType": "",
				"onlineStatus": 0,
				"ownerUid": "",
				"phone": "",
				"planId": 0,
				"productKey": "",
				"productName": "",
				"protocol": "",
				"roomName": "",
				"secondItemCode": "",
				"secondItemName": "",
				"shareCode": "",
				"sharingExpireAt": "",
				"sharingExpireTimeTs": 0,
				"signalStrength": "",
				"sn": "",
				"status": 0,
				"type": 0,
				"uid": "",
				"upgradeStatus": 0,
				"userConfirmStatus": 0,
				"userName": "",
				"verified": ""
			}
		],
		"navigateFirstPage": 0,
		"navigateLastPage": 0,
		"navigatePages": 0,
		"navigatepageNums": [],
		"nextPage": 0,
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"prePage": 0,
		"size": 0,
		"startRow": 0,
		"total": 0
	},
	"extMsg": "",
	"msg": ""
}