获取门锁的临时密码列表

更新时间:2023-12-07 03:34:02

本文介绍获取门锁的临时密码列表的 API。

接口描述

获取门锁的临时密码列表,可以查看有效、失效等多种数据

接口地址

GET: /v1.0/devices/{device_id}/door-lock/template/temp-password

请求参数

参数名类型参数位置是否必填说明

body 说明

参数名类型参数位置是否必填说明
is_recordBoolean false是否包含记录
data_typeInteger false
  • 数据类型
  • 0:仅查看有效数据
  • 1:仅查看失效数据
  • 2:查看所有数据
page_sizeInteger false每页记录数
offsetInteger false偏移量
device_idStringuritrue设备id

返回参数

参数名类型说明
resultOpenApiPagination

result 说明

参数名类型说明
totalInteger数据总数
unread_countInteger
total_pagesInteger总页数
recordsList分页数据
has_moreBoolean是否还有更多数据

records 说明

参数名类型说明
pwd_idLong密码编号
passwordString密码
pwd_typeInteger
  • 当前密码的类型
  • 0-周期性密码
  • 1-一次性密码
msg_idInteger密码信息编号
pwd_type_codeString
  • 密码类型
  • once-仅限一次使用的离线密码
  • temp-临时密码(自定义密码)
nameString密码名称
gmt_createLong密码创建时间(毫秒)
effective_timeLong密码生效时间(毫秒)
expired_timeLong密码失效时间(毫秒)
phoneString手机号码(带国家码),比如: 86-15158065546
schedule_detailsList周期性信息, 只有类型为周期性密码时才可能会有改值
snInteger周期性密码的序列号
operateString
  • 操作
  • ADD 新增
  • MODIFY 修改
  • DELETE 删除
delivery_statusString投递状态. 取值:
  • 投递状态
  • ONGOING 投递中
  • SUCCESS 成功
  • FAILED 失败
dev_name_listList可以解锁的设备名称列表
dev_id_listList可以解锁的设备编号列表
dev_ackInteger设备返回状态根据dp定义设置

schedule_details 说明

参数名类型说明
effective_timeLong开始时间。分钟形式存放,比如"07:30"的话,该值就是7x60+30=450
invalid_timeLong结束时间。分钟形式存放,比如"08:30"的话,该值就是8x60+30=510
working_dayInteger星期, 每个值累加:
  • 星期天:1
  • 星期一:2
  • 星期二:4
  • 星期三:8
  • 星期四:16
  • 星期五:32
  • 星期六:64
time_zone_idString时间区域
all_dayBoolean是否是全天

请求示例

GET: /v1.0/devices/6c7129x1yanlxgwx/door-lock/template/temp-password
{
  "isRecord": "true",
  "dataType": "0"
}

返回示例

{
    "tid": "1e5e62243ed811ed84fd2237f0528b74",
    "result": {
        "records": [
            {
                "effective_time": 1664269200,
                "schedule_details": [
                    {
                        "effective_time": 0,
                        "working_day": 127,
                        "all_day": false,
                        "invalid_time": 1439
                    }
                ],
                "pwd_id": 2876895,
                "expired_time": 1666861200,
                "password": "E86342BEF4228A1E741E38A5900FA61A",
                "operate": "CREATE",
                "name": "test9",
                "sn": -1,
                "msg_id": 81,
                "delivery_status": "ONGOING"
            },
            {
                "effective_time": 1664269200,
                "schedule_details": [
                    {
                        "effective_time": 0,
                        "working_day": 127,
                        "all_day": false,
                        "invalid_time": 1439
                    }
                ],
                "pwd_id": 2873619,
                "expired_time": 1666861200,
                "dev_ack": 2,
                "password": "080A9B713292AEE8203ADA6141F721E2",
                "operate": "DELETE",
                "name": "test13",
                "sn": 49,
                "msg_id": 80,
                "delivery_status": "FAILED"
            },
            {
                "effective_time": 1664269229,
                "schedule_details": [
                    {
                        "effective_time": 0,
                        "working_day": 127,
                        "all_day": false,
                        "invalid_time": 1439
                    }
                ],
                "pwd_id": 2871896,
                "expired_time": 1666861214,
                "password": "BC981F3595A36532EC6778EEE50DF3CE",
                "name": "测试",
                "sn": 48,
                "msg_id": 74,
                "delivery_status": "SUCCESS"
            }
        ],
        "has_more": true
    },
    "t": 1664333346974,
    "success": true
}

错误码

参考 错误码