沃土开放平台

API文档 > 设备管理类 > 设备查询接口
URL:http://gs-api.uface.uni-ubi.com/v1/{appId}/device/{deviceKey},method:GET
  • 发送设备序列号至云端,返回设备信息,可查询某台设备的名称、标签、所属appId、设备联网状态(status)、设备状态(state)、设备应用版本号(versionNo)、设备系统版本号(systemVersionNo)以及创建时间
  • 设备状态共有9种,查询可得知设备的创建、绑定、同步、禁用情况

需要查询某台设备的基本信息,或需要查询设备状态

设备创建、已同步后,一般都要查询该设备状态,以检查设备是否能够进行后续操作;当设备状态state为6:已同步,则设备可以开始授权和识别

字段 描述 类型 必传 说明
appId 应用Id String Y
token 调用接口凭证 String Y
deviceKey 设备序列号 String Y
{
	"result": 1,
	"code": "GS_SUS301",//设备查询接口调用成功
	"msg": "success",
	"data": {
	    "id": 735,//设备id
	    "userGuid": "73",//设备所有者(客户)guid
	    "deviceKey": "84E0F42005DCABCD",//设备序列号
	    "name": "测试设备",//设备名称
	    "state": 6,//设备状态,1:未绑定,2:绑定中,3:解绑中,4:未同步,5:同步中,6:已同步,7:已禁用,8:禁用中,9:启用中
	    "status": 2,//设备网络状态,1:在线,2:离线
	    "clientId": "e05279ad59c2f0bdd3f1309c17ad1234",//设备客户端id(极光),通常用于消息推送
	    "cid": null,// 设备客户端id(个推),通常用于消息推送
	    "versionNo": "2.4",//设备应用版本号
	    "systemVersionNo": "1.0",//设备系统版本号
	    "sceneGuid": "DCC85D9593554B33A4FCF7221BC9B0D3",//设备场景guid
	    "appId": null,//应用Id
	    "regNum":6,//设备总识别次数
	    "tag": "5d7bae2348d95efe862eca0a0b98035d",//设备tag(加密)
	    "needUpgradeApp": true,//是否需要APP升级
	    "needUpgradeSystem": true,//是否需要系统升级
	    "needUpgrade": true,//是否需要升级(包括app和系统升级)
	    "createTime": 1501222930000,//创建时间 ,类型毫秒时间戳  
	    "expired": false//设备是否禁用
	   },
	"success": true
}
state名称 设备状态state 照片在设备上的注册状态state (拍照)注册任务状态state
state说明 1:未绑定,设备-appId绑定关系
2:绑定中,设备与云端确认通信中
3:解绑中,设备删除中,与appId解绑中
4:未同步,云端数据未同步至设备
5:同步中,云端数据正在同步至设备
6:已同步,云端数据已同步至设备
7:已禁用,设备不可被使用
8:禁用中,设备正在“禁用”过程中
9:启用中,设备正在“启用”过程中
1:已上传
2:注册中
3:注册成功
4:注册失败
1:任务创建
2:准备就绪
3:开启失败
4:任务完成
5:任务过期
6:任务失败
出现接口名称
  • 设备查询
  • 设备列表查询
人员照片状态查询
  • 注册任务状态查询
  • 注册任务状态变更