Modify Temporary Password

Last Updated on : 2024-08-19 06:21:08download

Modify a temporary password of a smart lock.

API address

PUT: /v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
password_id	Long	uri	true	The password ID.

Description of body

Parameter name	Type	Required	Description
name	String	true	The password name.
password	String	true	Indicates the length of the original password. Valid values: Wi-Fi lock: 7. Zigbee lock/Bluetooth lock: 6. Encryption algorithm: AES. Mode: ECB mode and PKCS7Padding. Data block: 128 bits. Key: The original key. To get this key, decrypt the temporary key `ticket_key` with AES by using the `accessKey` that is issued by the Cloud Development Platform. The output is in the format of hex.
effective_time	Long	true	Effective time. The timestamp is in seconds (10-digit).
invalid_time	Long	true	Expiration time. The timestamp is in seconds (10-digit).
password_type	String	true	The password is encrypted using a `ticket`.
phone	String	false	The mobile phone number.
type	Integer	false	The validity type of password. Valid values: `1`: A password can only be used once before it expires. `0`: A password can be used as many times as needed before it expires.
time_zone	String	false	The time zone. This field is required if you require schedule tasks.
ticket_id	String	true	The ID of the temporary key.
schedule_list	List	false	The information about periodic passwords.

Description of schedule_list

Parameter name	Type	Required	Description
effective_time	Long	true	Start time. It is stored in minutes. For example, `07:30` indicates that the value is `450`. Calculation: 7 x 60 + 30 = 450.
invalid_time	Long	true	End time. It is stored in minutes. For example, `07:30` indicates that the value is `450`. Calculation: 7 x 60 + 30 = 450.
working_day	Integer	true	The working days. One week is represented in one byte. `bit0` to `bit6` respectively represent Sunday to Saturday. `1` means valid, `0` means invalid, and the last digit is represented by `0`. For example, Monday/Tuesday/Friday is represented as `00100110`, which equals `38`, so the value of `working_day` is 38.

Parameter name	Type	Description
result	Boolean	The operation result.

PUT: /v1.0/devices/vdevo15345926009****/door-lock/temp-passwords/xxx/modify-password

{
  "phone": "",
  "effective_time": "",
  "invalid_time": "",
  "password": "",
  "password_type": "ticket",
  "ticket_id": "xxx"
}

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

For more information, see error code.