调用该接口查询虚拟用户和单个钥匙的绑定关系,如果存在绑定关系则返回相应的关系信息,不存在则返回空。仅锁设备绑定的管理员查询有效。
路径 | /lock/key/user/bindinfo/get |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
virtualUserId | String | 是 | 虚拟用户的ID,与账户下创建的虚拟用户对应。 | |
lockUserId | String | 是 | 钥匙ID,由设备产生,对应锁端的锁用户ID。 | |
lockUserType | Int | 是 | 钥匙类型。1(表示指纹);2(表示密码);3(表示卡);4(表示钥匙)。 | |
iotId | String | 是 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 | |
userId | String | 否 | 淘宝账号ID信息。 | |
userType | String | 否 | 账号类型,淘宝:TAOBAO。 | |
origin | String | 否 | 标示来源,目前必须填写:TmallGenie。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
lockUserId | String |
钥匙ID,对应锁端的锁用户ID,由设备上报获。) |
|
lockUserType | Int |
钥匙类型,当对应的事件具备该出参时,才包含该字段。1(表示指纹);2(表示密码);3(表示卡);4(表示钥匙)。 |
|
lockUserPermType | Int |
钥匙权限,当对应的事件具备该出参时,才包含该字段。1(表示普通用户);2(表示管理员用户);3(表示胁迫用户) 。 |
|
keyNickName | String |
钥匙昵称,通过setKeyNickName设置过昵称后,在此处便可以获得昵称,否则为空。 |
|
userId | String |
虚拟用户ID。 |
|
identityId | String |
账户身份ID。 |
|
tenantId | String |
租户ID。 |
|
isolationId | String |
资源隔离ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"virtualUserId": "value0",
"lockUserId": "value1",
"lockUserType": "value2",
"iotId": "value3",
"userId": "value4",
"userType": "value5",
"origin": "value6"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"message": "success",
"data": {
"iotId" : "ChFrkX2Cxxxx10803d10",
"lockUserId": "10",
"lockUserType" : 1,
"lockUserPermType": 2,
"keyNickName": "keyNickNameTest",
"userId": "10B6336Exxxx28F58AA5A18",
"identityId": "5070opbxxxx3520731e258b2250",
"tenantId": "C9A562xxxxCDE5F01B3",
"isolationId": "a10xxxxLYnTrF8"
}
}
异常返回示例
JSON
格式
{}