查询设备信息
接口地址:/v2/binding/enduserapi/deviceInfo
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
查询设备的信息
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
dk | Device Key,配合 pk,和分享码二选一 | query | false | string | |
pk | Product Key,配合 dk,和分享码二选一 | query | false | string | |
shareCode | 分享码,和 pk、dk 二选一,被分享人使用分享码查询设备信息 | query | false | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | 查询设备信息成功 | 返回注册码响应数据«设备详情» |
5032 | token 验证失败 | |
5041 | 无权限 | |
5047 | 用户鉴权不匹配 | |
5052 | 设备未绑定 | |
5106 | 请输入token | |
5140 | 请输入pk、dk或者分享码 | |
5141 | 没有权限查询此设备 |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 响应数据 | 设备详情 | 设备详情 |
accessType | 访问类型:0-直连设备 1-网关设备 2-网关子设备 | string | |
activeTime | 激活时间 | string(date-time) | |
activeTimeTs | integer(int64) | ||
aiCapabilityStatus | AI能力开关状态 | boolean | |
authCode | authCode | string | |
authKey | authKey | string | |
bindMode | 绑定模式:1-多绑模式 2-唯一模式 3-轮流模式 | integer(int32) | |
bindStatus | 绑定状态:1-正常 2-失效 | integer(int32) | |
bindingCode | bindingCode | string | |
bindingType | 绑定类型:1 SN绑定 2 wifi绑定 3 PKDK绑定 4 蓝牙绑定 | integer(int32) | |
btLastUseTime | 蓝牙最近时间时间(毫秒时间戳) | integer(int64) | |
btPwd | btPwd | string | |
capabilitiesBitmask | 设备联网能力 | integer(int32) | |
deviceBindTime | 设备绑定时间 | string(date-time) | |
deviceBindTimeTs | integer(int64) | ||
deviceCreateTime | 设备创建时间 | string(date-time) | |
deviceCreateTimeTs | integer(int64) | ||
deviceKey | Device Key | string | |
deviceName | 设备名称 | string | |
deviceStatus | 设备状态 | string | |
deviceTag | 设备标签 | string | |
deviceType | 设备类型:1-自有设备 2-分享来的设备 | integer(int32) | |
fid | 家庭ID | string | |
firstItemCode | 一级品类code | string | |
firstItemName | 一级品类名称 | string | |
frid | 房间ID | string | |
gdid | 群组id | string | |
groupDeviceDeviceNum | 群组设备数 | integer(int32) | |
groupState | 群组权限 | integer(int32) | |
invaildTime | 失效时间 | string(date-time) | |
invaildTimeTs | integer(int64) | ||
isMatter | 是否是matter设备 | integer(int32) | |
isNative | 是否是移远设备 | integer(int32) | |
lastConnTime | 最后上线时间 | string(date-time) | |
lastConnTimeTs | integer(int64) | ||
lastOfflineTime | 离线时间 | string(date-time) | |
lastOfflineTimeTs | integer(int64) | ||
locateType | 支持的定位内容 | string | |
logoImage | 产品logo | string | |
lowPowerAlive | 低功耗心跳周期(分) | integer(int32) | |
lowPowerCache | 低功耗缓存时长,单位为秒 | integer(int32) | |
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(int32) | |
ownerUid | 分享人用户ID,来自谁的分享 | string | |
phone | 已绑定用户手机号 | string | |
planId | 升级计划ID | integer(int64) | |
productKey | Product Key | string | |
productName | 产品名称 | string | |
protocol | 接入协议 | string | |
secondItemCode | 二级品类code | string | |
secondItemName | 二级品类名称 | string | |
shareCode | 分享码 | string | |
sharingExpireAt | 设备使用到期时间 | string(date-time) | |
sharingExpireTimeTs | integer(int64) | ||
signalStrength | 信号强度 | string | |
sn | string | ||
status | 绑定状态:1-正常 2-失效 | integer(int32) | |
uid | 已绑定用户ID | string | |
upgradeStatus | 设备升级状态 | integer(int32) | |
userConfirmStatus | 用户确认状态 | integer(int32) | |
userName | 已绑定用户昵称 | string | |
verified | 设备绑定是否认证:0-未认证 1-已认证 | string(byte) | |
extMsg | 扩展消息 | string | |
msg | 响应消息 | string |
响应示例:
javascript
{
"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": ""
}