简体中文
简体中文
English
联系我们
注册
登录

门锁日志

更新时间:2022-03-18 07:25:05下载pdf

查询开门记录

说明: 本 API 仅支持老版本。

支持的门锁类型

  • Wi-Fi 门锁
  • 酒店 Zigbee 门锁
  • 蓝牙门锁

接口地址

GET /v1.0/devices/{device_id}/door-lock/open-logs

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
page_no Integer URL 页号
page_size Integer URL 分页大小
start_time Long URL 开始时间
end_time Long URL 结束时间

请求示例

GET /v1.0/devices/vdevo153459260090544/door-lock/open-logs?page_no=1&page_size=20&start_time=1543213146&end_time=1543213546

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 返回结果

result

参数名 类型 说明
total Integer 记录数量
logs List 开门记录列表

logs说明

参数名 类型 说明
status List 门锁状态列表
update_time Long 状态变更时间
unlock_name String 解锁方式名称
user_id String 成员 ID
nick_name String 成员名称

status说明

参数名 类型 说明
code String 状态码
value Object 状态值

状态码说明

参数名 类型 说明
unlock_fingerprint Long 指纹解锁,门锁本地分配的编号
unlock_password Long 密码解锁,门锁本地分配的编号
unlock_temporary Long 临时密码解锁,值为密码 ID
unlock_dynamic Long 动态密码解锁,值为密码 ID
unlock_card Long 卡片解锁,门锁本地分配的编号
unlock_face Long 人脸解锁,门锁本地分配的编号
unlock_key Long 机械钥匙解锁,门锁本地分配的编号
unlock_identity_card Long 身份证解锁,门锁本地分配的编号
unlock_emergency Long 应急密码解锁,门锁本地分配的编号

请求成功返回示例

{
    "success":true,
    "t":1542626129429,
    "result":{
        "total":1,
        "logs":[
            {
                "status":{
                    "code":"unlock_finger",
                    "value":"123456"
                },
		"nick_name":"",
                "unlock_name":"",
                "update_time":1612098422000,
                "user_id":"0"
            }
        ]
    }
}

请求失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error, please contact the admin"
}

查询开门记录

支持的门锁类型

  • Wi-Fi 门锁
  • 酒店 Zigbee 门锁
  • 蓝牙门锁
  • 可视对讲 Wi-Fi

接口地址

GET /v1.1/devices/{device_id}/door-lock/open-logs

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
page_no Integer URL 页号
page_size Integer URL 分页大小
start_time Long URL 开始时间
end_time Long URL 结束时间
showMediaInfo Boolean URL 是否显示图片信息

请求示例

GET /v1.1/devices/6cdb36b2e489885fa57lzm/door-lock/open-logs?page_no=1&page_size=3&start_time=1553053133000&end_time=1614008938000&show_media_info=true

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 返回结果

result

参数名 类型 说明
total Integer 记录数量
logs List 开门记录列表

logs说明

参数名 类型 说明
status List 门锁状态列表
update_time Long 状态变更时间
unlock_name String 解锁方式名称
user_id String 成员 ID
nick_name String 成员名称
media_infos List 媒体信息

media_infos说明

参数名 类型 说明
file_url String 封面图全路径
file_key String 文件密钥
media_url String 视频全路径
media_key String 视频密钥

status说明

参数名 类型 说明
code String 状态码
value Object 状态值

状态码说明

参数名 类型 说明
unlock_fingerprint Long 指纹解锁,门锁本地分配的编号
unlock_password Long 密码解锁,门锁本地分配的编号
unlock_temporary Long 临时密码解锁,值为密码 ID
unlock_dynamic Long 动态密码解锁,值为密码 ID
unlock_card Long 卡片解锁,门锁本地分配的编号
unlock_face Long 人脸解锁,门锁本地分配的编号
unlock_key Long 机械钥匙解锁,门锁本地分配的编号
unlock_identity_card Long 身份证解锁,门锁本地分配的编号
unlock_emergency Long 应急密码解锁,门锁本地分配的编号

请求成功返回示例

{
  "result": {
    "logs": [
      {
         "media_infos": [
          {
            "file_key": "uwu5m7kvj45av47g",
            "file_url": "https://..."
          }
        ],
        "nick_name": "",
        "status": {
          "code": "unlock_app",
          "value": "0"
        },
        "unlock_name": "",
        "update_time": 1613978384000,
        "user_id": "0"
      }
    ],
    "total": 1
  },
  "success": true,
  "t": 1614063791358
}

请求失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error, please contact the admin"
}

获取门锁告警记录

说明: 本 API 仅支持老版本。

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 酒店 Zigbee 门锁
  • 蓝牙门锁

接口地址

GET /v1.0/devices/{device_id}/door-lock/alarm-logs

请求参数

参数名 类型 参数类型 说明 是否必须
device_id String URI 设备 ID
page_no Integer URL 页号
page_size Integer URL 分页大小
dp_codes String URL 告警功能标准功能 code,用半角逗号(,)隔开,默认查询通用告警

请求示例

GET /v1.0/devices/vdevo153459260090544/door-lock/alarm-logs?page_no=1&page_size=20&dp_codes=hijack

返回参数

参数名 类型 说明
code Integer 错误响应码,成功时为空(详情⻅见错误码)
success Boolean 是否成功:(true:成功,false:失败)
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 返回结果

result

参数名 类型 说明
total Integer 记录数量
records List 告警记录列表

records说明

参数名 类型 说明
status List 门锁告警列表
update_time Long 状态变更时间
nickName String 用户名

status说明

参数名 类型 说明
code String 告警标准码
value Object 状态值(劫持告警的 value为:触发劫持的标准状态码-对应的状态 value)

请求成功返回示例

{
    "success":true,
    "t":1542626129429,
    "result":{
        "total":1,
        "records":[
            {
                "status":{
                    "code":"hijack",
                    "value":"unlock_fingerprint-02"
                },
                "update_time":1543297979
            }
        ]
    }
}

请求失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error,please contact the admin"
}

获取门锁告警记录

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 酒店 Zigbee 门锁
  • 蓝牙门锁
  • 可视对讲 Wi-Fi

接口地址

GET /v1.1/devices/{device_id}/door-lock/alarm-logs

请求参数

参数名 类型 参数类型 说明 是否必须
device_id String URI 设备 ID
page_no Integer URL 页号
page_size Integer URL 分页大小
dp_codes String URL 告警功能标准功能 code,用半角逗号(,)隔开,默认查询通用告警
show_media_info Boolean URL 是否显示图片信息

请求示例

GET /v1.1/devices/6ca87475b5bfbaa716felz/door-lock/alarm-logs?page_size=20&codes=doorbell&showMediaInfo=true&page_no=1

返回参数

参数名 类型 说明
code Integer 错误响应码,成功时为空(详情⻅见错误码)
success Boolean 是否成功:(true:成功,false:失败)
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 返回结果

result

参数名 类型 说明
total Integer 记录数量
records List 告警记录列表

records说明

参数名 类型 说明
status List 门锁告警列表
update_time Long 状态变更时间
nickName String 用户名
media_infos List 媒体信息

media_infos说明

参数名 类型 说明
file_url String 封面图全路径
file_key String 文件密钥
media_url String 视频全路径
media_key String 视频密钥

status说明

参数名 类型 说明
code String 告警标准码
value Object 状态值(劫持告警的 value 为:触发劫持的标准状态码-对应的状态 value)

请求成功返回示例

{
    "result": {
        "records": [
            {
                "media_infos": [
                    {
                        "file_key": "jxmgqs59gfr899qe",
                        "file_url": "https://ty-cn-storage60-1254153901.cos.tuyacn.com/"
                    }
                ],
                "nick_name": "",
                "status": [
                    {
                        "code": "alarm_lock",
                        "value": "wrong_password"
                    }
                ],
                "update_time": 1613979671000
            }
        ],
        "total": 1
    },
    "success": true,
    "t": 1614152402757
}

请求失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error,please contact the admin"
}

获取门锁告警记录和开门记录

支持的门锁类型

  • Wi-Fi 门禁

接口地址

GET /v1.0/devices/{device_id}/door-lock/records

请求参数

参数名 类型 参数类型 说明 是否必须
device_id String URI 设备 ID
target_standard_dp_codes String QUERY 需要查询的目标 dpCode (多个时以逗号分割)
start_time Long QUERY 时间范围的开始时间,不需要时间范围时传 0
end_time Long QUERY 时间范围的结束时间,不需要时间范围时传 0
page_no Integer QUERY 当前页数(从 1 开始计数)
page_size Integer QUERY 每页展示的条数

请求示例

GET /v1.0/devices/vdevo1623226445*****/door-lock/records?targetStandardDpCodes=unlock_password,unlock_card&startTime=0&endTime=0&pageNo=1&pageSize=10

返回参数

参数名 类型 说明
code Integer 错误响应码,成功时为空(详情⻅见错误码)
success Boolean 是否成功。(true:成功,false:失败)
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 返回结果

result

参数名 类型 说明
has_more Integer 是否还有更多数据
total_pages Integer 总页数
total Integer 数据总条数
records List 分页数据

records说明

参数名 类型 说明
record_id String 记录 ID
media_info_list List 多媒体信息,比如视频或者图片信息
union_unlock_info List 组合解锁信息集合
unlock_name String 解锁方式名称
gmt_create Long 创建时间
dps List DP 信息
avatar String 用户头像
member_bindable_flag Integer 当前记录是否可以关联人。
  • 1:可关联
  • 0:不能关联(可能已经关联过了)
user_id String 用户 ID
user_name String 用户名
record_type String 记录类型。
  • alarm:告警类型的记录
  • normal:普通开门记录

media_info_list说明

参数名 类型 说明
file_url String 封面图全路径
file_key String 文件密钥
media_url String 视频全路径
media_key String 视频密钥

union_unlock_info说明

参数名 类型 说明
user_name String 用户名
opmode String 解锁类型
unlock_name String 解锁方式名称

dps说明

dps 是一个数组,其中每个数据是一个 JSON 数据。key 为 dpCode,value 为 dpCode 对应的值。

请求成功返回示例

{
  "result": {
    "has_more": false,
    "records": [
      {
        "avatar": "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/smart/user_avatar/ay1565317415087U6QVp/F062FD1C-CA44-440A-9AE5-E270BE4826DD.png?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDopcCYgw0qRoyV5qfKjvg2pPkqESnb5zI%26q-sign-time%3D1624606578%3B1624610178%26q-key-time%3D1624606578%3B1624610178%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D467422052c41744943fa1c734ed9a44ad2ad7fe1",
        "dps": [
          {
            "unlock_password": "*"
          }
        ],
        "gmt_create": 1624604728299,
        "member_bindable_flag": 0,
        "record_id": "162460b8cfcbb6-d583-11eb-adea-0242878ef26647****",
        "record_type": "alarm",
        "unlock_name": "密码1",
        "user_id": "3066****",
        "user_name": "古树"
      }
    ],
    "total": 1,
    "total_pages": 1
  },
  "success": true,
  "t": 1624606578846
}

请求失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error,please contact the admin"
}

将历史记录关联给某个用户

支持的门锁类型

  • Wi-Fi 门禁

接口地址

POST /v1.0/devices/{device_id}/door-lock/records/{record_id}/actions/allocate

请求参数

参数名 类型 参数类型 说明 是否必须
device_id String URI 设备 ID
record_id String URI 历史记录 ID
user_id String BODY 用户 ID

请求示例

POST /v1.0/devices/vdevo16232264458****/door-lock/records/162315AAXEQDzL*****CRCxYNIADC506****/actions/allocate
{
  "userId": 1980012
}

响应参数

参数 类型 说明
result boolean 操作结果

响应成功示例

{
    "success": true,
    "t": 1571898808491,
    "result": true
}

相应失败返回示例

{
    "success": false,
    "code": 500, // 错误码,详细请见错误码文档
    "msg": "system error,please contact the admin"
}