Synchronize Unlocking Methods

Last Updated on : 2023-12-07 03:34:01download

This API is triggered when the user enters the member list or the hardware unlocking method list, or manually taps the button. The cloud will send a notification to the device, allowing the device to report all the data of one or more unlocking methods. For example, all fingerprints of a door lock are reported. The cloud compares the reported data with existing records and saves the differential data.

API address

POST: /v1.0/smart-lock/devices/{device_id}/opmodes/actions/sync

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
codes	String	query	true	The unlocking methods, separated with commas (,). Valid values: `unlock_fingerprint`: Unlock with fingerprint. `unlock_card`: Unlock with card. `unlock_password`: Unlock with password. `unlock_face`: Unlock with face recognition. `unlock_hand`: Unlock with palm print. `unlock_finger_vein`: Unlock with finger vein. `unlock_telecontrol_kit`: Unlock with remote control.

Return parameter

Parameter name	Type	Description
result	Boolean	Indicates whether the operation is successful.

Request example

POST: /v1.0/smart-lock/devices/vdevo12454656****/opmodes/actions/sync

{
  "codes": "unlock_fingerprint,unlock_password"
}

Return example

{
    "result": "true",
    "t": 1628487153553,
    "success": false
}

Error code

For more information, see error code.