Skip to content

电子钥匙

说明:主要对电子钥匙进行一些基础操作,例如冻结电子钥匙、解冻电子钥匙、删除电子钥匙、发送电子钥匙、删除密码等。

冻结电子钥匙

  • 调用方法
javascript
import { KeyFreeze } from 'star-cloud-web'

KeyFreeze(params)
  • 参数说明
名称类型是否必需示例描述
uidNumberY123用户uid
keyIdNumberY500电子钥匙ID
  • 返回

返回结果遵循 Result 方法的统一返回结构

解冻电子钥匙

  • 调用方法
javascript
import { KeyUnfreeze } from 'star-cloud-web'

KeyUnfreeze(params)
  • 参数说明
名称类型是否必需示例描述
uidNumberY123用户uid
keyIdNumberY500电子钥匙ID
  • 返回

返回结果遵循 Result 方法的统一返回结构

删除电子钥匙

  • 调用方法
javascript
import { KeyDelete } from 'star-cloud-web'

KeyDelete(params)
  • 参数说明
名称类型是否必需示例描述
uidNumberY123用户uid
keyIdNumberY500电子钥匙ID
  • 返回

返回结果遵循 Result 方法的统一返回结构

发送电子钥匙

  • 调用方法
javascript
import { KeySend } from 'star-cloud-web'

KeySend(params)
  • 参数说明
名称类型是否必需示例描述
uidNumberY123用户uid
receiverUsernameStringY"user@example.com"接收方用户账号,在云平台注册后返回获取的云平台username
receiverUsernameTypeNumberY1账号类型:1-手机号 2-邮箱号
keyNameStringY"我的钥匙"钥匙名称
lockIdNumberY500锁ID
keyTypeNumberY1钥匙类型(见常量列表)
startDateNumberN1609459200000开始时间:限时、循环钥匙必传,时间戳(毫秒)
endDateNumberN1609545600000结束时间:限时、循环钥匙必传,时间戳(毫秒)
weekDaysNumberN127循环周期:循环钥匙必填
keyRightNumberN0是否授权管理员,默认0:0-普通钥匙 1-授权管理员
remoteEnableNumberN0是否支持远程开锁:0-默认关闭 1-是 2-否
isCameraEnableNumberN0是否打开摄像头:0-默认关闭 1-是 2-否
faceAuthenticationNumberN0是否实名认证:0-默认关闭 1-是 2-否
isOnlyManageSelfNumberN0是否仅管理自己创建的用户(keyRight为1时生效):0-否 1-是
customInfoStringN"自定义内容"自定义内容(字符串)
remarksStringN"备注信息"备注
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

名称类型描述
keyIdNumber电子钥匙ID
receiverUidNumber接收方用户uid

删除密码

  • 调用方法
javascript
import { deletePassword } from 'star-cloud-web'

deletePassword(params)
  • 参数说明
名称类型是否必需示例描述
uidNumberY123用户uid
keyboardPwdIdNumberY100密码ID
  • 返回

返回结果遵循 Result 方法的统一返回结构

物联网设备通信协议文档