Query Family Device List

API Address:/v2/family/enduserapi/getFamilyDeviceList

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Query family device list

Request Parameters:

Parameter Name	Parameter Description	Request Type	Required	Data Type	Schema
fid	Family ID	query	true	string
deviceName	Device name, supports fuzzy search	query	false	string
isAddOwnerDevice	Whether to include all of the user's own devices: false - Return all devices added to the family true - Return all devices added to the family + all of the user's own devices	query	false	boolean
isAssociation	Whether to exclude already associated devices: false - Do not exclude associated devices true - Exclude associated devices	query	false	boolean
isGroupDeviceShow	Whether to show groups: false - Don't show groups true - Show groups	query	false	boolean
page	Current page, default is page 1	query	false	integer(int32)
pageSize	Page size, default is 10 items	query	false	integer(int32)
pkList	Product Key list, multiple keys separated by commas	query	false	string
secondItemCode	Secondary category code	query	false	string

Response Status:

Status Code	Description	Schema
200	Successfully queried family device list	Registration code response data«PageInfo«Query Family Device List»»
5041	No permission
5618	Please enter family ID
5635	Home mode not enabled
5676	Error calling product service

Response Parameters:

Parameter Name	Parameter Description	Type	Schema
code	Response status code	integer(int32)	integer(int32)
data	Response data	PageInfo«Query Family Device List»	PageInfo«Query Family Device List»
endRow		integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	Query Family Device List
accessType	Access type: 0-Direct device 1-Gateway device 2-Gateway sub-device	string
activeTime	Activation time	string
activeTimeTs		integer
aiCapabilityStatus	AI capability switch status	boolean
authCode	authCode	string
authKey	authKey	string
bindMode	Binding mode: 1-Multi-binding mode 2-Unique mode 3-Rotation mode	integer
bindStatus	Binding status: 1-Normal 2-Invalid	integer
bindingCode	bindingCode	string
bindingType	Binding type: 1 SN binding 2 WiFi binding 3 PKDK binding 4 Bluetooth binding	integer
btLastUseTime	Bluetooth most recent use time (millisecond timestamp)	integer
btPwd	btPwd	string
capabilitiesBitmask	Device network capabilities	integer
commonUsed		boolean
deviceBindTime	Device binding time	string
deviceBindTimeTs		integer
deviceCreateTime	Device creation time	string
deviceCreateTimeTs		integer
deviceKey	Device Key	string
deviceName	Device name	string
deviceStatus	Device status	string
deviceTag	Device tag	string
deviceType	Device type: 1-Own device 2-Shared device	integer
fid	Family ID	string
firstItemCode	Primary category code	string
firstItemName	Primary category name	string
frid	Family room ID	string
gdid	Group ID	string
groupDeviceDeviceNum	Number of group devices	integer
groupState	Group permissions	integer
invaildTime	Invalidation time	string
invaildTimeTs		integer
isCommonUsed	Whether it is a commonly used device	boolean
isMatter	Whether it is a Matter device, 0-No 1-Yes	integer
isNative	Whether it is a third-party device, 0-Unknown 1-Quectel	integer
lastConnTime	Last online time	string
lastConnTimeTs		integer
lastOfflineTime	Offline time	string
lastOfflineTimeTs		integer
locateType	Supported location content	string
logoImage	Product logo	string
lowPowerAlive	Low power heartbeat period (minutes)	integer
lowPowerCache	Low power cache duration, in seconds	integer
lowPowerProduct	Whether it is a low power product. Yes: true, No: false	boolean
lowPowerStatus	Low power status switch	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	Network type: 1-WiFi 2-Cellular 3-NB 5-Bluetooth	string
onlineStatus	Device online status: 0-Offline 1-Online	integer
ownerUid	Sharer user ID, shared from whom	string
phone	Bound user's phone number	string
planId	Upgrade plan ID	integer
productKey	Product Key	string
productName	Product name	string
protocol	Access protocol	string
roomName	Room name	string
secondItemCode	Secondary category code	string
secondItemName	Secondary category name	string
shareCode	Share code	string
sharingExpireAt	Device usage expiration time	string
sharingExpireTimeTs		integer
signalStrength	Signal strength	string
sn		string
status	Binding status: 1-Normal 2-Invalid	integer
type	Binding type	integer
uid	Bound user ID	string
upgradeStatus	Device upgrade status	integer
userConfirmStatus	User confirmation status	integer
userName	Bound user's nickname	string
verified	Device binding authentication: 0-Not authenticated 1-Authenticated	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	Extended message	string
msg	Response message	string

Response Example:

{
	"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": ""
}