Get Alert Records

Last Updated on : 2024-08-19 06:23:01download

Get alert records of a smart lock.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
page_no	Integer	query	true	The page number.
page_size	Integer	query	true	The number of items returned on each page.
codes	String	query	false	The codes of standard data points of alerts, separated with half-width commas (,). Valid values: `hijack`: duress alert. `alarm_lock`: general alert. Default value. `doorbell`: doorbell prompt.

Return parameter

Parameter name	Type	Description
result	Pagination

Description of result

Parameter name	Type	Description
total	Integer	The total number of alert records.
records	List	The list of alert records.

Description of records

Parameter name	Type	Description
status	List	The list of lock alerts.
update_time	Long	The time when the status is updated.
nick_name	String	The username.

Description of status

Parameter name	Type	Description
code	String	DP code of alerts.
value	Object	Status value. The value of the duress alarm is the unlocking method number of the standard status code set to trigger a duress event.

Request example

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

Return example

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

Error code

For more information, see error code.