获取常保活门锁的周期性临时密码列表

更新时间：2023-12-07 03:34:00下载pdf

本文介绍获取常保活门锁的周期性临时密码列表的 API。

接口描述

根据请求的 valid 参数返回有效的或者失效的密码，有效列表第一次调用时，也会返回上一次下发失败的密码。再次调用后，下发失败的密码将被归类到失效的临时密码里，不再在有效列表里展示。

接口地址

GET: /v1.0/smart-lock/devices/{device_id}/stand-by-lock-temp-passwords

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	uri	true	设备 ID
valid	Boolean	query	true	是否有效
last_row_key	String	query	false	查询分页记录时的行号（来自于返回结果的 last_row_key，没有时传空）
page_size	Integer	query	true	每页记录数

返回参数

参数名	类型	说明
result	RowBasedPagination

result 说明

参数名	类型	说明
last_row_key	String	查询下一个分页时，需要传的行号
has_more	Boolean	是否还有更多数据
records	List

records 说明

参数名	类型	说明
password_id	Long	密码 ID
pwd_type_code	String	自定义临时密码，固定为 temp
name	String	密码名称
gmt_create	Long	密码创建时间（单位为秒）
effective_time	Long	生效时间（单位为秒）
expired_time	Long	失效时间（单位为秒）
phone	String	手机号码（带国家码），比如: 86-1515806****
schedule_details	List	周期性信息, 只有类型为周期性密码时才可能会有该值
sn	Integer	临时密码在门锁上的编号
operate	String	操作 ADD：新增 MODIFY：修改 DELETE：删除
delivery_status	String	投递状态： ONGOING：下发中 SUCCESS：下发成功 FAILED：下发失败
effective_flag	Integer	生效状态： 0：无效 1：生效中 2：待生效（时间未到的情况）

schedule_details 说明

参数名	类型	说明
start_minute	Long	一天里开始生效分钟
end_minute	Long	一天里开始失效分钟
working_day	Integer	星期, 每个值累加： 1：星期天 2：星期一 4：星期二 8：星期三 16：星期四 32：星期五 64：星期六
time_zone_id	String	时区
all_day	Boolean	是否全天

请求示例

GET: /v1.0/smart-lock/devices/vdevo12454656****/stand-by-lock-temp-passwords

{
  "device_id": "vdevo12454656****",
  "valid": true,
  "last_row_key": "ABCDEFG",
  "page_size": 20
}

返回示例

{
    "last_row_key": "ABCDEFG",
    "records": [
        {
            "effective_time": 1628006400,
            "gmt_create": 1628088594,
            "schedule_details": [
                {
                    "working_day": 101,
                    "all_day": false,
                    "end_minute": 2359,
                    "start_minute": 0
                }
            ],
            "expired_time": 1628265540,
            "operate": "CREATE",
            "password_id": 3351004,
            "phone": "",
            "name": "369369",
            "pwd_type_code": "temp",
            "effective_flag": 1,
            "sn": 0,
            "delivery_status": "SUCCESS"
        }
    ],
    "has_more": false
}

错误码

参考错误码。