智能小程序 Ray 开发门锁 API ——解锁 API 接口汇总

解锁 API

远程免密开门功能

remoteOpenDoor

引入

@ray-js/ray^1.5.0 以上版本可使用

import { remoteOpenDoor } from '@ray-js/ray'

参数

RemoteOpenParams

属性	类型	必填	说明
devId	string	是	设备 Id
open	boolean	是	是否开门

返回

RemoteOpenResponse

boolean，远程免密开门的响应结果。

函数定义示例

/**
 * 远程免密开门
 */
export function remoteOpenDoor(params: RemoteOpenParams): Promise<RemoteOpenResponse>

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

远程免密解锁功能

remoteUnlockDoor

引入

@ray-js/ray^1.5.0 以上版本可使用

import { remoteUnlockDoor } from '@ray-js/ray'

参数

UnlockParams

属性	类型	必填	说明
devId	string	是	设备 Id
open	boolean	是	是否开门
confirm	boolean	是	是否确认，蓝牙门锁固定传 false

返回

UnlockResponse

boolean，远程免密解锁的响应结果。

函数定义示例

/**
 * 远程免密解锁
 */
export function remoteUnlockDoor(params: UnlockParams): Promise<UnlockResponse>

判断用户是否可以远程开门功能

checkCanRemoteUnlock

引入

@ray-js/ray^1.5.0 以上版本可使用

import { checkCanRemoteUnlock } from '@ray-js/ray'

参数

CanUnlockRemoteParams

属性	类型	必填	说明
devId	string	是	设备 Id

返回

CanUnlockRemoteResponse

boolean，判断用户是否可以远程开门的响应结果。

函数定义示例

/**
 * 判断用户是否可以远程开门
 */
export function checkCanRemoteUnlock(
  params: CanUnlockRemoteParams
): Promise<CanUnlockRemoteResponse>

获取最近一条记录的信息

getLatestUnlockRecord

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getLatestUnlockRecord } from '@ray-js/ray'

参数

GetLatestRecordInfoParams

属性	类型	必填	说明
devId	string	是	设备 Id

返回

GetLatestRecordInfoResponse

属性	类型	说明
dpId	number	类型(门锁端 dpId)
dpValue	string	dp 值
recordType	number	记录类型
userName	string	用户名称
time	number	时间
unionUnlockInfo	UnlockRecord[]	组合开锁信息
unReadCount	number	未读记录数

UnlockRecord

属性	类型	说明
userName	string	组合开锁的用户名称
opMode	string	组合开锁的解锁方式
unlockName	string	组合开锁的解锁方式名称

函数定义示例

/**
 * 获取最近一条记录的信息
 */
export function getLatestUnlockRecord(
  params: GetLatestRecordInfoParams
): Promise<GetLatestRecordInfoResponse>

查询开门记录功能

queryUnlockRecord

引入

@ray-js/ray^1.5.0 以上版本可使用

import { queryUnlockRecord } from '@ray-js/ray'

参数

QueryRecordInfoParams

属性	类型	必填	说明
devId	string	是	门锁编号
dpIds	string[]	是	dpId 列表
offset	number	否	起始页
limit	number	否	每页数据大小
startTime	number	否	开始时间
endTime	number	否	结束时间
nameless	boolean	否	是否仅查询匿名的记录

返回

QueryRecordInfoResponse

属性	类型	说明
id	number	绑定的编号
dpId	number	类型(门锁端 dpId)
userId	string	开门的用户编号
unlockName	string	解锁方式名称(如果有)
userName	string	用户名称
avatarUrl	string	用户头像
time	number	时间
relateDevName	string	关联设备的名称
relateOpMode	number	关联设备的解锁方式
unionUnlockInfo	QueryUnlockRecord[]	组合开锁信息

QueryUnlockRecord

属性	类型	说明
userName	string	组合开锁的用户名称
opMode	string	组合开锁的解锁方式
unlockName	string	组合开锁的解锁方式名称

函数定义示例

/**
 * 查询开门记录
 */
export function queryUnlockRecord(params: QueryRecordInfoParams): Promise<QueryRecordInfoResponse[]>

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。