Query Device Information

API Address:/v2/binding/enduserapi/deviceInfo

Request Method:GET

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

Response Data Type:*/*

API Description:Query device information

Request Parameters:

Parameter Name	Parameter Description	Request Type	Required	Data Type	Schema
dk	Device Key, used together with pk, choose either this or share code	query	false	string
pk	Product Key, used together with dk, choose either this or share code	query	false	string
shareCode	Share code, choose either this or pk and dk, used by share recipient to query device information	query	false	string

Response Status:

Status Code	Description	Schema
200	Device information query successful	Registration code response data«Device Details»
5032	Token verification failed
5041	No permission
5047	User authentication mismatch
5052	Device not bound
5106	Please enter token
5140	Please enter pk, dk or share code
5141	No permission to query this device

Response Parameters:

Parameter Name	Parameter Description	Type	Schema
code	Response status code	integer(int32)	integer(int32)
data	Response data	Device Details	Device Details
accessType	Access type: 0-Direct device 1-Gateway device 2-Gateway sub-device	string
activeTime	Activation time	string(date-time)
activeTimeTs		integer(int64)
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(int32)
bindStatus	Binding status: 1-Normal 2-Invalid	integer(int32)
bindingCode	bindingCode	string
bindingType	Binding type: 1 SN binding 2 WiFi binding 3 PKDK binding 4 Bluetooth binding	integer(int32)
btLastUseTime	Bluetooth most recent use time (millisecond timestamp)	integer(int64)
btPwd	btPwd	string
capabilitiesBitmask	Device network capabilities	integer(int32)
deviceBindTime	Device binding time	string(date-time)
deviceBindTimeTs		integer(int64)
deviceCreateTime	Device creation time	string(date-time)
deviceCreateTimeTs		integer(int64)
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(int32)
fid	Family ID	string
firstItemCode	Primary category code	string
firstItemName	Primary category name	string
frid	Room ID	string
gdid	Group ID	string
groupDeviceDeviceNum	Number of group devices	integer(int32)
groupState	Group permissions	integer(int32)
invaildTime	Invalidation time	string(date-time)
invaildTimeTs		integer(int64)
isMatter	Whether it is a Matter device	integer(int32)
isNative	Whether it is a Quectel device	integer(int32)
lastConnTime	Last online time	string(date-time)
lastConnTimeTs		integer(int64)
lastOfflineTime	Offline time	string(date-time)
lastOfflineTimeTs		integer(int64)
locateType	Supported location content	string
logoImage	Product logo	string
lowPowerAlive	Low power heartbeat period (minutes)	integer(int32)
lowPowerCache	Low power cache duration, in seconds	integer(int32)
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(int32)
ownerUid	Sharer user ID, shared from whom	string
phone	Bound user's phone number	string
planId	Upgrade plan ID	integer(int64)
productKey	Product Key	string
productName	Product name	string
protocol	Access protocol	string
secondItemCode	Secondary category code	string
secondItemName	Secondary category name	string
shareCode	Share code	string
sharingExpireAt	Device usage expiration time	string(date-time)
sharingExpireTimeTs		integer(int64)
signalStrength	Signal strength	string
sn		string
status	Binding status: 1-Normal 2-Invalid	integer(int32)
uid	Bound user ID	string
upgradeStatus	Device upgrade status	integer(int32)
userConfirmStatus	User confirmation status	integer(int32)
userName	Bound user's nickname	string
verified	Device binding authentication: 0-Not authenticated 1-Authenticated	string(byte)
extMsg	Extended message	string
msg	Response message	string

Response Example:

{
	"code": 0,
	"data": {
		"accessType": "",
		"activeTime": "",
		"activeTimeTs": 0,
		"aiCapabilityStatus": true,
		"authCode": "",
		"authKey": "",
		"bindMode": 0,
		"bindStatus": 0,
		"bindingCode": "",
		"bindingType": 0,
		"btLastUseTime": 0,
		"btPwd": "",
		"capabilitiesBitmask": 0,
		"deviceBindTime": "",
		"deviceBindTimeTs": 0,
		"deviceCreateTime": "",
		"deviceCreateTimeTs": 0,
		"deviceKey": "",
		"deviceName": "",
		"deviceStatus": "",
		"deviceTag": "",
		"deviceType": 0,
		"fid": "",
		"firstItemCode": "",
		"firstItemName": "",
		"frid": "",
		"gdid": "",
		"groupDeviceDeviceNum": 0,
		"groupState": 0,
		"invaildTime": "",
		"invaildTimeTs": 0,
		"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": "",
		"secondItemCode": "",
		"secondItemName": "",
		"shareCode": "",
		"sharingExpireAt": "",
		"sharingExpireTimeTs": 0,
		"signalStrength": "",
		"sn": "",
		"status": 0,
		"uid": "",
		"upgradeStatus": 0,
		"userConfirmStatus": 0,
		"userName": "",
		"verified": ""
	},
	"extMsg": "",
	"msg": ""
}