日志模块 SDK

开始之前

微信生态对接较复杂，需开发者熟悉相应技术、具备相应对接经验。请先联系涂鸦工作人员进行咨询评估，然后再决定是否启动 SDK 开发。

概述

@ray-js/wechat-ms-log SDK 提供门锁小程序的日志相关能力，包括获取最新日志和所有日志数据。

安装

yarn add @ray-js/wechat-ms-log

// or

npm install @ray-js/wechat-ms-log

获取所有日志记录数据

getLogList

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true
start_time	number	起始时间，不限时间则传 0	true
end_time	number	结束时间，不限时间则传 0	true
user_ids	string	家庭成员用户 ID	false
log_categories	string	日志大类 operation：操作日志 unlock_record：开门记录 close_record：关门记录 alarm_record：告警记录	false
last_row_key	string	上一次查询的最后一条记录 Key，有上一次查询记录会返回该参数，第一次请求的时候不用传	false
page_size	number	每一页返回的数据条数，最大值 100	false
only_show_media_record	boolean	是否带图片 true：带图片 false：不带图片	false

返回参数

参数名	类型	描述
has_more	boolean	是否有更多数据
last_row_key	string	上一次查询的最后一条记录 Key
records	IResult[]	结果项列表

IResult

参数名	类型	描述
current_user	boolean	是否是当前用户的记录，非组合解锁必返回该参数
data	IData	告警或操作记录的详情数据
dp_id	number	功能点（Data Point，DP）ID
log_category	string	日志大类 operation：操作日志 unlock_record：开门记录 close_record：关门记录 alarm_record：告警记录
log_id	number	日志编号
log_type	ILogType	日志类型
media_info_list	IMediaInfo[]	开门时拍的照片或者视频信息
member_bindable_flag	number	是否可以将本条日志上报的开锁方式关联到指定的联系人 1：可以关联 0：不可以关联（可能已经关联过联系人）
record_type	number	记录类型，仅开门记录里返回该参数 1：普通开门记录 2：告警记录
time	number	日志事件时间，毫秒时间戳
unlock_name	string	解锁方式名称，可能为空
user_id	string	用户编号，仅开门记录、劫持告警和操作记录里返回该参数
user_name	string	开锁用户名或者开锁密码名称
union_unlock_info	IUnlockInfo[]	组合解锁信息

IMediaInfo

参数名	类型	描述
file_url	string	文件地址，全路径
file_key	string	加密密钥
file_path	string	文件路径
bucket	string	文件所在的 Bucket
media_key	string	实时视频拉流密钥，跳转音视频播放地址时，需要携带该数据
media_url	string	实时视频拉流地址，跳转音视频播放地址时，需要携带该数据

IUnlockInfo

参数名	类型	描述
user_name	string	触发组合解锁的用户名称（可能为空）
op_mode	string	组合解锁时，解锁方式类型
unlock_name	string	组合解锁时，解锁方式名称（可能为空）
current_user	boolean	组合解锁时，是否是当前用户
sn	number	组合解锁时，硬件编号

IData string

示例

值	含义
wrong_password	密码连续验证错误
wrong_finger	指纹连续验证错误
wrong_card	门卡连续验证错误
wrong_face	人脸连续验证错误
wrong_finger_vein	指静脉连续试错
wrong_unlock	连续验证试错告警
tongue_bad	锁舌被卡住
too_hot	高温告警
unclosed_time	超时未关门
tongue_not_out	锁舌未弹出
pry	防撬告警
key_in	钥匙插入提醒
low_battery	低电量告警
power_off	电量耗尽告警
shock	震动告警
defense	布防告警
doorbell	门铃告警
stay_alarm	逗留告警
modi_pass	修改密码通知
add_finger	添加指纹通知
del_finger	初始化密码及删除指纹通知
try_open	远程锁定后尝试开锁告警

ILogType string

示例（可根据 DP 名称定义）

值	含义
dev_bind	设备绑定
unlock_temporary	自定义临时密码
unlock_dynamic	动态密码
unlock_offline_pd	离线密码
unlock_phone_remote	远程解锁
doorbell	门铃呼叫

获取最近一条日志记录

getlogLatest

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true

返回参数

参数名	类型	描述
current_user	boolean	是否是当前用户的记录，非组合解锁必返回该参数
data	string	告警或操作记录的详情数据
dp_id	number	DP ID
exist	boolean	是否存在最近一条日志记录
log_category	string	日志大类 operation：操作日志 unlock_record：开门记录 close_record：关门记录 alarm_record：告警记录
log_id	number	日志编号
log_type	string	日志类型
record_type	number	记录类型，仅开门记录里返回该参数 1：普通开门记录 2：告警记录
time	number	日志事件时间
member_bindable_flag	boolean	是否可以关联联系人
un_read_count	number	未读记录数
unlock_name	string	解锁方式名称，可能为空
user_id	string	用户编号，仅开门记录、劫持告警和操作记录里返回该参数
user_name	string	用户名称
union_unlock_info	IUnlockInfo[]	组合解锁信息

获取最新 2 条日志记录

getLogLatestNew

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true

返回参数

参数名	类型	描述
unReadCount	number	未读记录数
operateRecordVOList	ILogInfo[]	告警或操作记录的详情数据

ILogInfo

参数名	类型	描述
currentUser	boolean	是否是当前用户的记录，非组合解锁必返回该参数
data	string	告警或操作记录的详情数据
dpId	number	DP ID
logCategory	string	日志大类 operation：操作日志 unlock_record：开门记录 close_record：关门记录 alarm_record：告警记录
logId	number	日志编号
logType	string	日志类型
recordType	number	记录类型，仅开门记录里返回该参数 1：普通开门记录 2：告警记录
time	number	日志事件时间
unlockName	string	解锁方式名称，可能为空
userId	string	用户编号，仅开门记录、劫持告警和操作记录里返回该参数
userName	string	用户名称
memberBindableFlag	boolean	是否可以关联联系人
mediaInfoList	IMediaInfo[]	媒体信息

IMediaInfo

参数名	类型	描述
mediaPath	string	未读记录数
mediaUrl	string	告警或操作记录的详情数据
mediaKey	string	告警或操作记录的详情数据