Smart Door Lock

This topic describes the processes and APIs of developing smart lock in the Cloud Development Platform. The smart lock cloud development applies to lock-related service implementation through customers’ self-built server, including but not limited to the WeChat mini program, Web system, and H5 application.

Connection process

Before connecting to lock products of the vertical resources, you need to register as a developer in the Tuya Cloud Development Platform. For more information, see Quick Start.

The process of Tuya smart lock cloud development is shown as follows:

Applicable category

Interface log

You can query interface call logs of the last seven days from the current date. You provide the interface request parameters and submit a ticket in the IoT Console. Generally, Tuya service team will respond to your ticket within two hours. For urgent problems, you can contact the project manager to speed up the process through offline channels.

API list

The following table lists the APIs used by smart locks:

Description: APIs marked with an asterisk (*) only support the old version.

For more information, see the following documentation.

Note: In consideration of security, remote unlocking is not available. If you need this unlocking method, contact the responsible project manager to apply for relevant APIs.

Password creation

• Wi-Fi lock working flow:

  

• Zigbee lock working flow:

  

  • Normal working flow of Zigbee lock:

    • The caller calls APIs to create a password.
    • Tuya Cloud Platform sends the password to the gateway.
    • The gateway sends the password to the lock.
    • The lock responds to the password status: configuration succeeded.
    • The gateway sends the password status: configuration succeeded.
    • Tuya Cloud Platform stores and updates password status: configuration succeeded.
    • The password status is polled by the caller until it is changed to “configuration succeeded” or “configuration failed”. The polling times out after 25 seconds.

  • Abnormal working flow of Zigbee lock:

    • The caller calls APIs to get lock information.
    • The caller call APIs to create a password (encrypted with the lock local key).
    • Tuya Cloud Platform sends the password to the gateway.
    • The gateway sends the password to the lock.
    • The lock does not respond.
    • The gateway retries sending the password for three times.
    • The gateway reports the password status: configuration failed.
    • Tuya Cloud Platform stores and updates password status: configuration failed.
    • The password status is polled by the caller until it is changed to “configuration succeeded” or “configuration failed”. The polling times out after 25 seconds.

Password encryption process

Flowchart

Lock APIs

Get the temporary key for password encryption

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

POST /v1.0/devices/{device_id}/door-lock/password-ticket

Request parameter

Request example

POST /v1.0/devices/vdevo153459260090544/door-lock/password-ticket

Return parameter

Description of result

Return example of successful request

{
    "result": {
  	"expire_time": 360,
  	"ticket_id": "9wxxoLM",
  	"ticket_key": 		"901CC35A67DA3429C38E9622xxxxx3EAE1CE333462356D257FD1D3E5C"
    },
    "success": true,
    "t": 1592899848757
}

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error,please contact the admin"
}

Create temporary password

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

POST /v1.0/devices/{device_id}/door-lock/temp-password

Request parameter

schedule_list

Request example

POST /v1.0/devices/vdevo153459260090544/door-lock/temp-password

{
    "password": "956FAD7xxxxxx09C68E168B77",
    "password_type": "ticket",
    "ticket_id": "xxxxxx",
    "effective_time": 1579156726,
    "invalid_time": 1579243126,
    "name":"test",
    "phone": 11233213,
    "time_zone":"",
    "schedule_list":[{
   	"effective_time": 720,
   	"invalid_time": 1080,
   	"working_day":  0
    }]
}

Return parameter

Description of result

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error,please contact the admin"
}

Create an unnamed temporary password

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

POST /v2.0/devices/{device_id}/door-lock/temp-password

Request parameter

schedule_list

Request example

POST /v2.0/devices/vdevo153459260090544/door-lock/temp-password

{
    "password": "956FAD7xxxxxx09C68E168B77",
    "password_type": "ticket",
    "ticket_id": "xxxxxx",
    "effective_time": 1579156726,
    "invalid_time": 1579243126,
    "phone": 11233213,
    "time_zone":"",
    "schedule_list":[{
   	"effective_time": 720,
   	"invalid_time": 1080,
   	"working_day":  0
    }]
}

Return parameter

Description of result

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error,please contact the admin"
}

Synchronize password

Applicable lock types

It applies to Zigbee lock.

After a password is created for the Zigbee lock, if the password status is still in “configuring”, this interface can be called to synchronize the “configuring” password in the server to the lock. For a single device, this interface can only be sent once within 60 seconds.

Interface address

POST /v1.0/devices/{device_id}/door-lock/issue-password

Request parameter

Request example

POST /v1.0/devices/vdevo153459260090544/door-lock/issue-password

{
   "password_id":""
}

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error,please contact the admin"
}

Get temporary password information

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

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

Request parameter

Request example

GET /v1.0/devices/vdevo153459260090544/door-lock/temp-password/xxxx

Return parameter

Description of result

schedule_list

Phase description

Zigbee: 1: to be created. 2: normal. 3: frozen. 4: deleted. 5: creation failed. 
Wi-Fi: 0: deleted. 1: to be sent. 2: sent. 3: to be deleted. 
Bluetooth: 0: deleted. 1: to be sent. 2: sent. 3: to be deleted. 7: sent failed.

Return example of successful request

{
    "success": true,
    "t": 1542626129429,
    "result": {
  	"password_id": 1001, //Primary key of the temporary password
  	"effective_time": 1530841779, //10-bit valid time
  	"invalid_time": 1530881779, //10-bit invalid time
  	"name": "Tenant A's password", //Temporary password name
  	"phase": 1, //Password status
  	"phone": "123547127362",
  	"time_zone":"Asia/Shanghai",
  	"delivery_status": 1
    }
}

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Get temporary password list

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

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

Request parameter

Request example

GET /v1.0/devices/vdevo153459260090544/door-lock/temp-passwords

Return parameter

Description of result

schedule_list

Phase description

Zigbee: 1: to be created. 2: normal. 3: frozen. 4: deleted. 5: creation failed. 
Wi-Fi: 0: deleted. 1: to be sent. 2: sent. 3: to be deleted. 
Bluetooth: 0: deleted. 1: to be sent. 2: sent. 3: to be deleted. 7: sent failed.

Return example of successful request

{
    "success": true,
    "t": 1542626129429,
    "result": [
  	{
  	"password_id": 1001, //Primary key of the temporary password
  	"effective_time": 1530841779, //10-bit valid time
  	"invalid_time": 1530881779, //10-bit invalid time
 	 "name": "Tenant A's password", //Temporary password name
  	"phase": 1, //Password status  
  	"phone": "123547127362",
  	"time_zone":"Asia/Shanghai",
  	"delivery_status": 1
 	 }
    ]
}

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "System exception. Contact the administrator"
}

Modify temporary password

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock (password cannot be modified).

Interface address

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

Request parameter

schedule_list

Request example

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

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

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error,please contact the admin"
}

Freeze temporary password

Applicable lock types

It applies to Zigbee lock.

Interface address

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

Request parameter

Request example

PUT /v1.0/devices/vdevo153459260090544/door-lock/temp-passwords/xxx/freeze-password

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Unfreeze temporary password

Applicable lock types

It applies to Zigbee lock.

Interface address

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

Request parameter

Request example

PUT /v1.0/devices/vdevo153459260090544/door-lock/temp-passwords/xxx/unfreeze-password

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Delete temporary password

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

DELETE /v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}

Request parameter

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Get dynamic password

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

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

Request parameter

Request example

GET /v1.0/devices/vdevo153459260090544/door-lock/dynamic-password

Return parameter

Description of result

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Get an offline temporary password

Applicable lock types

It applies to Wi-Fi lock.

Interface address

POST /v1.0/devices/{device_id}/door-lock/offline-temp-password

Request parameter

Request example

POST /v1.0/devices/vdevo153459260090544/door-lock/offline-temp-password

Return parameter

Description of result

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Query unlocking history

Note: This API only supports the old version.

Applicable lock types

It applies to Wi-Fi lock and Zigbee lock.

Interface address

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

Request parameter

Request example

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

Return parameter

Description of result

Description of logs

Description of status

Description of status code

Return example of successful request

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

Return example of failed request

{
    "success": false,
    "code": 500, // Error code. For more information, see the error code documentation
    "msg": "system error, please contact the admin"
}

Query unlocking history

Applicable lock types

It applies to Wi-Fi lock and Zigbee lock.

Interface address

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

Request parameter

Request example

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

Return parameter

Description of result

Description of logs

Description of media_infos

Description of status

Description of status code

Return example of successful request

{
  "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
}

Return example of failed request

{
    "success": false,
    "code": 500,
    "msg": "system error, please contact the admin"
}

Query unlock alarm history

Applicable lock types

It applies to Wi-Fi lock and Zigbee lock.

Interface address

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

Request parameter

Request example

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

Return parameter

Description of result

Description of logs

Description of media_infos

Description of status

Description of status code

Return example of successful request

{
    "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
}

Return example of failed request

{
    "success": false,
    "code": 500, 
    "msg": "system error, please contact the admin"
}

Device member management

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Add a device member

Interface address

POST /v1.0/devices/{device_id}/user

Request parameter

Response parameter

Description of result parameter

Modify the device member

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

PUT /v1.0/devices/{device_id}/users/{user_id}

Request parameter

Response parameter

Remove device member

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

DELETE /v1.0/devices/{device_id}/users/{user_id}

Request parameter

Response parameter

Query device member information

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

GET /v1.0/devices/{device_id}/users/{user_id}

Request parameter

Response parameter

Query member information list by the device ID

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

GET /v1.0/devices/{device_id}/users

Request parameter

Response parameter

Assign password to device members

Applicable lock types
|

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Request address

POST /v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate

Request parameter

Response parameter

Example of successful response

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

Unlocking method APIs

Flowchart

Get the list of unlocking methods that are bound to lock members

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

GET /v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys

Request parameter

Request example

GET /v1.0/devices/xxx/door-lock/user-types/2/users/xxx/assigned-keys? unlock_type=card

Return parameter

Description of result

unlock_keys description

Return example of successful request

{
    "result":{
    "unlock_keys":[
    	{
 	"unlock_no":3,
 	"unlock_type":"card",
 	"hijack":false
    	}
    ]
    },
    "success":true,
    "t":1593843316481
}

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Get the list of unlocking methods that are not bound to lock members

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

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

Request parameter

Request example

GET /v1.0/devices/xxxx/door-lock/unassigned-keys? unlock_type=card

Return parameter

Description of result

unlock_keys description

Return example of successful request

{
    "result":{
    "unlock_keys":[
  	{
 	"unlock_no":3,
 	"unlock_type":"card"
  	}
    ]
    },
    "success":true,
    "t":1593843316481
}

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Unlocking method enrollment

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

PUT /v1.0/devices/{device_id}/door-lock/actions/entry

Request parameter

Request example

PUT /v1.0/devices/xxx/door-lock/actions/entry

{
    "unlock_type":"card",
    "user_type":2,
    "user_id":"000xxxwsn"
}

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Delete unlocking method

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

DELETE /v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no}

Request parameter

Request example

DELETE /v1.0/devices/xxxx/door-lock/user-types/2/users/xxxx/unlock-types/fingerprint/keys/30

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Cancel unlocking method enrollment

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

PUT /v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel

Request parameter

Request example

PUT /v1.0/devices/xxx/door-lock/unlock-types/card/actions/cancel

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Set to anti-hijack unlocking

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Interface address

PUT /v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack

Request parameter

Request example

PUT /v1.0/devices/xxx/door-lock/unlock-types/card/keys/130/hijack

Return parameter

Return example of successful request

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

Return example of failed request

{
    "success":false,
    "code":500, // Error code. For more information, see the error code documentation
    "msg":"system error,please contact the admin"
}

Sending control for common lock capabilities

• Cloud Development Platform–Standard command set for smart locks
• Cloud Development Platform–Device control

Push result of unlocking method enrollment

Applicable lock types

It applies to Wi-Fi lock, Zigbee lock, and Bluetooth lock.

Service data

bizCode description

bizData description

Data format

{
    "bizCode":"doorUnlockMethodStatus",
    "bizData":{
  	"finish":false,
  	"operate":1,
  	"raised":true,
  	"totalPeriod":2,
  	"period":2,
	"event":"unlockMethodEntry"
    },
    "uuid":"xxxx",
    "devId":"xxxx"
}

door unlock with snapshot pictures

• Remote door unlock with snapshot picture process：
  

• Remote door unlock with snapped pictures-real-time scene
  - The user triggers the camera lock to open the door, and the door lock
  captures the picture and reports it to the cloud service
  - Cloud service stores image data and pushes relative storage location information to the client
  - The client calls the cloud service to obtain the full path of image storage
  - The client obtains the encrypted image data and decrypts it
  - According to the obtained image information, the user judges to open the door or cancel, and call the corresponding interface
  - The cloud service is issued to the camera lock, and the door is opened/cancelled

• Remote door unlock with snapped pictures(non-real-time scene)
  - The client calls the cloud service to query the image information of the most recent door opening/warning within 90s
  - The client obtains the encrypted image data and decrypts it
  - According to the obtained image information, the user judges to open the door or cancel, and call the corresponding interface
  - The cloud service is issued to the camera lock, and the door is opened/cancelled

Image information is encrypted by AES/CBC/PKCS5Padding，The rules are as follows：

The decryption demo is shown below:

package xxxxxxx;
 
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.util.Random;
 
import javax.crypto.Cipher;
import javax.crypto.CipherInputStream;
import javax.crypto.CipherOutputStream;
import javax.crypto.NoSuchPaddingException;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
 
public class EncryptUtils {
 
    private static final String DEFAULT_ALGORITHM = "AES";
    private static final String DEFAULT_FULL_ALGORITHM = "AES/CBC/PKCS5Padding";
 
    public static File encryptFile(String key, File originFile, String destPath) {
        FileInputStream in = null;
        FileOutputStream out = null;
        File destFile = null;
        try {
            destFile = new File(destPath);
            if (originFile.exists() && originFile.isFile()) {
                if (!destFile.getParentFile().exists()) {
                    destFile.getParentFile().mkdirs();
                }
                destFile.createNewFile();
                in = new FileInputStream(originFile);
                out = new FileOutputStream(destFile, true);
                byte[] iv = getIv();
                Cipher cipher = initAESCipher(iv, key, Cipher.ENCRYPT_MODE);
                CipherInputStream cipherInputStream = new CipherInputStream(in, cipher);
                byte[] cache = new byte[1024];
                int nRead;
                out.write(new byte[4]);
                out.write(iv);
                out.write(new byte[4]);
                out.write(new byte[40]);
                out.flush();
                while ((nRead = cipherInputStream.read(cache)) != -1) {
                    out.write(cache, 0, nRead);
                    out.flush();
                }
                cipherInputStream.close();
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (out != null) {
                    out.close();
                }
                if (in != null) {
                    in.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return destFile;
    }

    public static File decryptFile(String key, InputStream in, File destFile) {
        FileOutputStream out = null;
        try {
            if (!destFile.getParentFile().exists()) {
                destFile.getParentFile().mkdirs();
            }
            destFile.createNewFile();
            out = new FileOutputStream(destFile);
 
            byte[] iv = new byte[16];
            in.skip(4);
            int read = in.read(iv);
            if (read != 16) {
                throw new IOException("iv length error");
            }
            in.skip(44);
            Cipher cipher = initAESCipher(iv, key, Cipher.DECRYPT_MODE);
            CipherOutputStream cipherOutputStream = new CipherOutputStream(out, cipher);
            byte[] buffer = new byte[1024];
            int r;
            while ((r = in.read(buffer)) >= 0) {
                cipherOutputStream.write(buffer, 0, r);
            }
            cipherOutputStream.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (in != null) {
                    in.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
            try {
                if (out != null) {
                    out.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return destFile;
    }
 
    private static Cipher initAESCipher(byte[] iv, String sKey, int cipherMode) {
        try {
            IvParameterSpec zeroIv = new IvParameterSpec(iv);
            SecretKeySpec key = new SecretKeySpec(sKey.getBytes(), DEFAULT_ALGORITHM);
            Cipher cipher = Cipher.getInstance(DEFAULT_FULL_ALGORITHM);
            cipher.init(cipherMode, key, zeroIv);
            return cipher;
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        } catch (NoSuchPaddingException e) {
            e.printStackTrace();
        } catch (InvalidKeyException e) {
            e.printStackTrace();
        } catch (InvalidAlgorithmParameterException e) {
            e.printStackTrace();
        }
        return null;
    }
 
    public static byte[] getIv() {
        StringBuilder uid = new StringBuilder();
        Random rd = new SecureRandom();
        for (int i = 0; i < 16; i++) {
            int type = rd.nextInt(3);
            switch (type) {
                case 0:
                    uid.append(rd.nextInt(10));
                    break;
                case 1:
                    uid.append((char) (rd.nextInt(25) + 65));
                    break;
                case 2:
                    uid.append((char) (rd.nextInt(25) + 97));
                    break;
                default:
                    break;
            }
        }
        return uid.toString().getBytes();
    }
 
}

Get the alarm image and video url in real time

Applicable lock types

It applies to Wi-Fi lock and Zigbee lock.

Interface address

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

Request parameter

Request example

GET /v1.0/devices/6cdb36b2e489885fa57lzm/door-lock/media/url?bucket=ty-cn-storage60-1254153901&file_path=/3039e1-3053202d1d483fa63/cmmon/16139779690g

Return parameter

Description of result

Return example of successful request

{
  "result": {
    "file_url": "https://...",
    "media_url": "https://..."
  },
  "success": true,
  "t": 1614063791358
}

Return example of failed request

{
    "success": false,
    "code": 500, 
    "msg": "system error, please contact the admin"
}

Get the latest unlocking or alarm image

Applicable lock types

It applies to Wi-Fi lock and Zigbee lock.

Interface address

GET /v1.0/devices/{device_id}/door-lock/latest/media/url

Request parameter

Request example

GET /v1.0/devices/6cdb36b2e489885fa57lzm/door-lock/latest/media/url?file_type=1

Return parameter

Description of result

Return example of successful request

{
    "result": {
        "bucket": "ty-cn-storage60-1254153901",
        "file_key": "u8kstrtjm7qun83q",
        "file_path": "/3039e1-30532026.jpg",
        "file_url": "https://ty-cn-storage60-1254153901.cos.tuyacn.com6"
    },
    "success": true,
    "t": 1614147303662
}

Return example of failed request

{
    "success": false,
    "code": 500, 
    "msg": "system error, please contact the admin"
}