TTLock Open Platform

https://euopen.ttlock.com/doc/
Admin
TTLock Open Platform provides APIs and SDKs for integrating smart lock management, including...
Tokens:287,046
Snippets:1,678
Trust Score:7.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get Working Mode - response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/lock/getWorkingModeEn.html

Example response showing workingMode 3 and cyclicConfig with isAllDay, startTime, endTime, and weekDays fields.

```json
{
     "workingMode": 3, 
     "cyclicConfig":[{"isAllDay":2,"startTime":480,"endTime":1080,"weekDays":[1,2]}]
}
```

--------------------------------

### TTLock Initialization and Setup

Source: https://euopen.ttlock.com/doc/sdk/ios/instruction

Steps to import the TTLock header, create a TTLock object, start Bluetooth, enable debug logging, and handle manager state updates.

```APIDOC
## TTLock Initialization and Setup

### Description
Initialize the TTLock object, start Bluetooth, and configure debug logging.

### Method
N/A (SDK setup)

### Endpoint
N/A

### Parameters
#### Import Header
- **TTLock.h** (Header) - Required - Main class header
- **TTSDKDelegate.h** (Header) - Required - Delegate protocol header
- **TTSpecialValueUtil.h** (Header) - Required - Special value utility class
- **TTUtils.h** (Header) - Required - Utility class
- **SecurityUtil.h** (Header) - Required - Security utility class

### Request Example
```objc
#import <TTLock/TTLock.h>
TTLock *TTObject = [[TTLock alloc]initWithDelegate:self];
[TTObject setupBlueTooth];
[TTLock setDebug:YES];
```

### Response
#### Success Response (200)
- **state** (TTManagerState) - The current state of the central manager.

#### Response Example
```json
{
  "state": "TTManagerStatePoweredOn"
}
```

### Error Handling
- If Bluetooth is powered off, the delegate method `TTManagerDidUpdateState:` is called with `TTManagerStatePoweredOff`.
- If Bluetooth is unsupported, the delegate method is called with `TTManagerStateUnsupported`.
```

--------------------------------

### Response example with executeToken

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/eletricMeter/admin/createExecuteTokenEn.html

Response example showing the executeToken value returned by the API.

```json
{
    "executeToken": 11223344
}
```

--------------------------------

### Response example for configAlertFlag

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/doorSensor/standaloneDoorSensor/configAlertFlagEn.html

Example response showing a successful configuration with errcode 0 and a description field indicating success.

```json
{
    "errcode": 0, 
    "errmsg": "none error message",
    "description":"表示成功或是"
}
```

--------------------------------

### Response example for waterMeter/listRecords

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/waterMeter/admin/listRecordsEn.html

Response example showing a list of water usage records with dateType, usedM3, and createDate fields.

```json
{
    "list": [
        {
            "dateType": 2,
            "usedM3": "0.00t",
            "createDate": "2025-06"
        }
    ]
}
```

--------------------------------

### Response example for adding wireless keypad

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/wirelessKeypad/addEn.html

Example response from the wirelessKeypad/add API. It returns the wirelessKeypadId of the newly added keypad.

```json
{
    "wirelessKeypadId": 4242
}
```

--------------------------------

### JSON response example for getData

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/qrCode/getDataEn.html

Example response showing lockAlias, type, qrCodeNumber, qrCodeContent, name, startDate, endDate, and status. The cyclicConfig field is not present in this example.

```json
{
    "lockAlias": "Front door lock",
    "type": 1,
    "qrCodeNumber": 2,
    "qrCodeContent": "xxxxxxxxxxxxxxx",
    "name": "QR code for alexa",
    "startDate": 1625025703000,
    "endDate": 1665025703000,
    "status": 1
}
```

--------------------------------

### Response example for query lock settings

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/lock/querySettingEn.html

Example JSON response showing a value of 1, representing the queried lock setting.

```json
{
    "value": 1
}
```

--------------------------------

### Response example for decodeBleAdvertising

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/eletricMeter/admin/decodeBleAdvertisingEn.html

Example response showing a successful decode with errcode 0 and a description indicating success.

```json
{
  "errcode": 0,
  "errmsg": "none error message or means yes",
  "description": "表示成功或是"
}
```

--------------------------------

### Response example for lock time adjustment

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/gateway/adjustLockDatetimeEn.html

Example response body showing the adjusted lock time in epoch milliseconds.

```json
{
    "date": 1625025703000
}
```

--------------------------------

### Get DS3 alert - response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/doorSensor/standaloneDoorSensor/getAlertFlagEn.html

Example response containing alert flags and their thresholds: notCloseAlertFlag, notCloseAlertSecondNum, longTimeNotOpenAlertFlag, and longTimeNotOpenDayNum.

```json
{
    "notCloseAlertFlag": 1, 
    "notCloseAlertSecondNum": 100,
    "longTimeNotOpenAlertFlag": 1,
    "longTimeNotOpenDayNum": 10
}
```

--------------------------------

### prepareBTService

Source: https://euopen.ttlock.com/doc/sdk/v3/android/gatewayInterface

Initializes the Bluetooth configuration.

```APIDOC
## prepareBTService

### Description
Initializes the Bluetooth configuration.

### Method
prepareBTService

### Signature
`public void prepareBTService(Context context)`

### Parameters
- **context** (Context) - Required - The application context.
```

--------------------------------

### startBleService(Context context)

Source: https://euopen.ttlock.com/doc/sdk/android/interface

Starts the Bluetooth service. This initializes the Bluetooth service for the SDK.

```APIDOC
## startBleService(Context context)

### Description
Starts the Bluetooth service.

### Method
`public void startBleService(Context context)`

### Parameters
- **context** (Context) - Required - The application context.
```

--------------------------------

### Response example for getPassageModeConfiguration

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/lock/getPassageModeConfigurationEn.html

Example response showing the passage mode configuration. The cyclicConfig array is sorted by start and end time, with all-day entries at the top.

```json
{
    "passageMode": 1, 
    "cyclicConfig":[{"isAllDay":2,"startTime":480,"endTime":1080,"weekDays":[1,2]}],
    "autoUnlock": 1
}
```

--------------------------------

### Configure WiFi and Init Gateway

Source: https://euopen.ttlock.com/documentPages/htmlPages/appSdkV3/androidSdkDemoV3/androidExample/gatewayEn.html

Sets the gateway's UID, user password, WiFi SSID, WiFi password, and nickname, then initializes the gateway via Bluetooth. The callback reports success with device info or a GatewayError on failure.

```java
configureGatewayInfo.uid = MyApplication.getmInstance().getAccountInfo().getUid();
configureGatewayInfo.userPwd = MyApplication.getmInstance().getAccountInfo().getMd5Pwd();
 
configureGatewayInfo.ssid = binding.wifiName.getText().toString().trim();
 
configureGatewayInfo.wifiPwd = binding.wifiPwd.getText().toString().trim();
 
configureGatewayInfo.plugName = device.getAddress();
 
GatewayClient.getDefault().initGateway(configureGatewayInfo, new InitGatewayCallback() {
    @Override
    public void onInitGatewaySuccess(DeviceInfo deviceInfo) {
        LogUtil.d("gateway init success");
        isInitSuccess(deviceInfo);
    }
 
    @Override
    public void onFail(GatewayError error) {
 
    }
});
```

--------------------------------

### GET /v3/gateway/list

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/gateway/listEn.html

This snippet documents the GET /v3/gateway/list endpoint, which lists the gateways belonging to a user account. It includes the request parameters, a curl example, and the response structure.

```APIDOC
## GET /v3/gateway/list

### Description
List the gateways belong to a user account.

### Method
GET

### Endpoint
https://api.sciener.com/v3/gateway/list

### Parameters
#### Query Parameters
- **clientId** (string) - Required - The client ID.
- **accessToken** (string) - Required - The access token of the user.
- **pageNo** (integer) - Required - The page number.
- **pageSize** (integer) - Required - The number of items per page.
- **date** (integer) - Required - The timestamp in milliseconds.

### Request Example
```
curl --location --request GET 'https://api.sciener.com/v3/gateway/list?clientId=4773aa036f7f49c68d876bb4be85c80c&accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f&pageNo=1&pageSize=20&date=1626674054000'
```

### Response
#### Success Response (200)
- **list** (array) - The list of gateways.
  - **gatewayId** (integer) - The gateway ID.
  - **gatewayMac** (string) - The gateway MAC address.
  - **gatewayVersion** (integer) - The gateway version.
  - **networkName** (string) - The network name.
  - **lockNum** (integer) - The number of locks.
  - **isOnline** (integer) - Whether the gateway is online (1 for online).
- **pageNo** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **pages** (integer) - The total number of pages.
- **total** (integer) - The total number of gateways.

#### Response Example
```
{
    "list": [
        {
            "gatewayId": 78979,
            "gatewayMac": "C5:40:E0:9C:8C:C1",
            "gatewayVersion": 1,
            "networkName": "1-101-WIFI",
            "lockNum": 2,
            "isOnline": 1
        }
    ],
    "pageNo": 1,
    "pageSize": 20,
    "pages": 1,
    "total": 1
}
```
```

--------------------------------

### POST /v3/gateway/setUpgradeMode

Source: https://euopen.ttlock.com/doc/api/v3/gateway/setUpgradeMode

API documentation for setting a gateway into upgrade mode.

```APIDOC
## [POST] https://api.sciener.com/v3/gateway/setUpgradeMode

### Description
Set gateway into upgrade mode remotely. When a gateway is in upgrade mode, it can't accept commands.

### Method
POST

### Endpoint
https://api.sciener.com/v3/gateway/setUpgradeMode

### Parameters
#### Request Body
- **clientId** (String) - Required - The app_id which is assigned by system when you create an application
- **accessToken** (String) - Required - Access token
- **gatewayId** (Int) - Required - Gateway ID
- **date** (Long) - Required - Current time (timestamp in millisecond)

### Response
#### Success Response (200)
- **errcode** (Int) - Error code
- **errmsg** (String) - Error message

#### Response Example
{
    "errcode": 0, 
    "errmsg": "none error message",
    "description": "none error message or means yes"
}
```

--------------------------------

### Get fingerprint list request

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/fingerprint/listEn.html

Example request to list fingerprints for a lock. Uses the GET method with query parameters clientId, accessToken, lockId, pageNo, pageSize, and date.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/fingerprint/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'
```

--------------------------------

### Get unlock records with curl

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/lockRecord/listEn.html

Example GET request to the lock record list endpoint. The URL includes clientId, accessToken, lockId, startDate, endDate, pageNo, pageSize, and date parameters.

```bash
curl --location --request GET 'https://api.sciener.com/v3/lockRecord/list?clientId=4773aa036f7f49c68d876bb4be85c80c&accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f&lockId=163377&startDate=1526674054000&endDate=1626674054000&pageNo=1&pageSize=20&date=1626674054000'
```

--------------------------------

### Setup Bluetooth in AppDelegate

Source: https://euopen.ttlock.com/doc/sdk/v3/ios/instruction

Call setupBluetooth in didFinishLaunchingWithOptions to initialize TTLock. Optionally enable printLog by uncommenting the line. The callback logs the Bluetooth state.

```objectivec
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //TTLock.printLog = YES;
    [TTLock setupBluetooth:^(TTBluetoothState state) {
        NSLog(@"##############  TTLock is working, bluetooth state: %ld  ##############",(long)state);
    }];

    return YES;
}
```

--------------------------------

### List QR codes with curl GET request

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/qrCode/listEn.html

Example request to list all QR codes of a lock. Uses the GET method with query parameters clientId, accessToken, lockId, pageNo, pageSize, and date.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/qrCode/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=163377&pageNo=1&pageSize=20&date=1625025703000'
```

--------------------------------

### Get one ekey - Response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/ekey/getEn.html

Response body for the get ekey request. Contains key details such as keyId, lockData, lockId, userType, keyStatus, lockName, lockAlias, lockMac, noKeyPwd, electricQuantity, and startDate.

```json
{
    "keyId": 3234293,
    "lockData": "xxxxxxx",
    "lockId": 532323,
    "userType": "110302",
    "keyStatus": "110401",
    "lockName": "M102_ed8e8d",
    "lockAlias": "Front door lock",
    "lockMac": "68:9E:19:00:67:81",
    "noKeyPwd": "345634",
    "electricQuantity": 85,
    "startDate": 1528878400000
}
```

--------------------------------

### cURL request example for GET /v3/face/list

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/face/listEn.html

Sends a GET request to the face list endpoint with query parameters clientId, accessToken, lockId, pageNo, pageSize, and date. Use this to retrieve the face list for a specific lock.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/face/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'
```

--------------------------------

### Success response for configCatOneInfo

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/eletricMeter/admin/configCatOneInfoEn.html

Example success response for the configCatOneInfo endpoint. Shows errcode 0, errmsg 'none error message or means yes', and a description field indicating success.

```json
{
    "errcode": 0,
    "errmsg": "none error message or means yes",
    "description": "表示成功或是"     
}
```

--------------------------------

### Response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/nb/getPlatformIpAndPortEn.html

Response object for the NB-IoT cloud server info request.

```json
{
    "list": [

```

--------------------------------

### Request example for group list

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/group/listEn.html

Sends a GET request to the group list endpoint with clientId, accessToken, and date query parameters.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/group/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&date=1625025703000'
```

--------------------------------

### cURL request example for GET /v3/lock/listKey

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/ekey/listByLockEn.html

Use this cURL command to list all common ekeys of a lock. The request is a GET to https://api.sciener.com/v3/lock/listKey with query parameters clientId, accessToken, lockId, pageNo, pageSize, and date. The response contains a list of ekeys, excluding the top administrator's ekey.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/lock/listKey?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'
```

--------------------------------

### Setup Bluetooth with TTLock

Source: https://euopen.ttlock.com/documentPages/htmlPages/appSdkV3/iosSdkDemoV3/iosExample/instructionEn.html

Initialize Bluetooth in the app delegate's didFinishLaunchingWithOptions. The commented line enables debug logging. The callback logs the Bluetooth state.

```objectivec
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //TTLock.printLog = YES;
    [TTLock setupBluetooth:^(TTBluetoothState state) {
        NSLog(@"##############  TTLock is working, bluetooth state: %ld  ##############",(long)state);
    }];
 
    return YES;
}
```

--------------------------------

### Response example for listRecords

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/eletricMeter/admin/listRecordsEn.html

Example JSON response containing a list of electricity usage records. Each record includes dateType, usedKwh, and createDate fields.

```json
{
    "list": [
        {
            "dateType": 2,
            "usedKwh": "0.00kWh",
            "createDate": "2025-06"
        }
    ]
}
```

--------------------------------

### Register API response with prefixed username

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/user/registerEn.html

Example response from the register API. Contains the prefixed username that must be used to get an access token and to bind with your own user account.

```json
{
    "username": "abcd_c042f4db68f23406c6cecf84a7ebb0fe"
}
```

--------------------------------

### Response example: list of devices

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/gateway/listDeviceEn.html

Response body showing the list of devices connected to the gateway. The list contains objects with device information.

```json
{
    "list": [
        {

```

--------------------------------

### Request example: curl GET queryDate

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/gateway/queryLockDatetimeEn.html

Use this curl command to query the lock time. It requires clientId, accessToken, lockId, and date parameters. The date parameter is a timestamp in milliseconds.

```bash
curl --location --request GET 'https://api.sciener.com/v3/lock/queryDate?clientId=4773aa036f7f49c68d876bb4be85c80c&accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f&lockId=163377&date=1626674054000'
```

--------------------------------

### cURL request example for GET /v3/key/get

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/ekey/getEn.html

Use this cURL command to call the Sciener API and retrieve an ekey. The request requires clientId, accessToken, lockId, and date query parameters. The response contains the ekey details.

```bash
curl --location -g --request GET 'https://api.sciener.com/v3/key/get?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&date=1625025703000'
```

--------------------------------

### Correct demonstration - sequential lock operations

Source: https://euopen.ttlock.com/doc/sdk/ios/instruction

Shows the correct way to perform multiple operations on a TTLock lock: wait for the callback of the previous operation before starting the next one. In this example, the lock is unlocked first, and only after that callback completes is the time calibrated.

```Objective-C
-(void)onBTConnectSuccess_peripheral:(CBPeripheral *)peripheral lockName:(NSString*)lockName{

    // unlock
    [TTObject unlockByUser_lockKey:lockKey 
            aesKey:aesKeyStr 
            startDate:startDate 
            endDate:endDate 
            version:version 
            unlockFlag:unlockFlag 
            uniqueid:uniqueid 
            timezoneRawOffset:timezoneRawOffset];
    
    //calibrate time
    [TTObject setLockTime_lockKey:lockKey 
            aesKey:aesKeyStr 
            version:version 
            unlockFlag:unlockFlag 
            referenceTime:referenceTime 
            timezoneRawOffset:timezoneRawOffset];
}
```

--------------------------------

### Start Bluetooth

Source: https://euopen.ttlock.com/doc/sdk/ios/instruction

Start Bluetooth for the TTLock SDK.

```objective-c
[TTObject setupBlueTooth];
```

--------------------------------

### initGateway

Source: https://euopen.ttlock.com/doc/sdk/v3/android/gatewayInterface

Initializes a gateway with the provided configuration.

```APIDOC
## initGateway

### Description
Initializes a gateway with the provided configuration.

### Method
initGateway

### Signature
`public void initGateway(@NonNull ConfigureGatewayInfo configureInfo, InitGatewayCallback callback)`

### Parameters
- **configureInfo** (ConfigureGatewayInfo) - Required - The configuration information for the gateway.
- **callback** (InitGatewayCallback) - Required - Callback for initialization result.
```

--------------------------------

### Example response for key list

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/ekey/listEn.html

Example JSON response from the key list endpoint. Contains a list of eKey objects with fields such as keyId, lockData, lockId, userType, keyStatus, lockName, lockAlias, lockMac, noKeyPwd, electricQuantity, startDate, endDate, remarks, keyRight, featureValue, remoteEnable, passageMode, groupId, and groupName, plus pagination fields pageNo, pageSize, pages, and total.

```json
{
    "list": [
        {
            "keyId": 3234293,
            "lockData": "xxxxxxx",
            "lockId": 532323,
            "userType": "110302",
            "keyStatus": "110401",
            "lockName": "M102_ed8e8d",
            "lockAlias": "Front door lock",
            "lockMac": "68:9E:19:00:67:81",
            "noKeyPwd": "345634",
            "electricQuantity": 85,
            "startDate": 1528878944000,
            "endDate": 1628878944000,
            "remarks": "Wish you a happy rent.",
            "keyRight": 1,
            "featureValue": "6C4CD1F3",
            "remoteEnable": 0,
            "passageMode": 1,
            "groupId": 7619,
            "groupName": "The 4th floor"
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}
```

--------------------------------

### Start Bluetooth Scan

Source: https://euopen.ttlock.com/doc/sdk/android/instruction

Start scanning for nearby Bluetooth devices.

```java
mTTLockAPI.startBTDeviceScan();
```

--------------------------------

### JSON response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/passcode/listEn.html

Example response showing a list of passcode objects with fields like keyboardPwdId, lockId, keyboardPwd, keyboardPwdName, keyboardPwdType, startDate, endDate, sendDate, and senderUsername, along with pagination info.

```json
{
    "list": [
        {
            "keyboardPwdId": 3234293,
            "lockId": 532323,
            "keyboardPwd": "034234",
            "keyboardPwdName":"Passcode for Jack",
            "keyboardPwdType": "3",
            "startDate": 1528878944000,
            "endDate": 1628878944000,
            "sendDate": 1528878944000,
            "senderUsername": "alexa@google.com"
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}
```

--------------------------------

### Start Bluetooth Service

Source: https://euopen.ttlock.com/doc/sdk/android/instruction

Start the Bluetooth service required for communication.

```java
mTTLockAPI.startBleService(mContext);
```

--------------------------------

### Response example

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/gateway/listEn.html

The response contains a list of gateways with details such as gatewayId, gatewayMac, gatewayVersion, networkName, lockNum, and isOnline, along with pagination fields pageNo, pageSize, and pages.

```json
{
    "list": [
        {
            "gatewayId": 78979,
            "gatewayMac": "C5:40:E0:9C:8C:C1",
            "gatewayVersion":1,
            "networkName": "1-101-WIFI",
            "lockNum": 2,
            "isOnline": 1   
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}
```

--------------------------------

### GET /v3/lock/detail

Source: https://euopen.ttlock.com/documentPages/htmlPages/cloud/lock/detailEn.html

Retrieves details of a specific lock. Only the lock's administrator is allowed to get lock details. The ekey user can request cloud API to get the lockData of a lock.

```APIDOC
## [GET] /v3/lock/detail

### Description
Retrieves details of a specific lock. Only the lock's administrator is allowed to get lock details. The ekey user can request cloud API to get the lockData of a lock.

### Method
GET

### Endpoint
https://api.sciener.com/v3/lock/detail

### Parameters
#### Query Parameters
- **clientId** (string) - Required - The client ID.
- **accessToken** (string) - Required - The access token.
- **lockId** (integer) - Required - The ID of the lock.
- **date** (integer) - Required - The timestamp of the request.

### Request Example
```
curl --location -g --request GET 'https://api.sciener.com/v3/lock/detail?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=10&date=1625025703000'
```

### Response
#### Success Response (200)
- **date** (integer) - The timestamp of the response.
- **lockAlias** (string) - The alias of the lock.
- **lockSound** (integer) - The lock sound setting.
- **modelNum** (string) - The model number of the lock.
- **lockMac** (string) - The MAC address of the lock.
- **privacyLock** (integer) - Privacy lock setting.
- **featureValue** (string) - Feature value of the lock.
- **soundVolume** (integer) - The sound volume.
- **hasGateway** (integer) - Whether the lock has a gateway.
- **autoLockTime** (integer) - The auto-lock time in seconds.
- **lockName** (string) - The name of the lock.
- **resetButton** (integer) - Whether the reset button is enabled.
- **firmwareRevision** (string) - The firmware revision.
- **tamperAlert** (integer) - Whether tamper alert is enabled.
- **noKeyPwd** (string) - The no-key password.
- **passageMode** (integer) - The passage mode setting.
- **passageModeAutoUnlock** (integer) - The passage mode auto-unlock setting.
- **timezoneRawOffset** (integer) - The timezone raw offset in milliseconds.
- **lockId** (integer) - The ID of the lock.
- **electricQuantity** (integer) - The battery level percentage.
- **hardwareRevision** (string) - The hardware revision.
- **firmwareRevision** (string) - The firmware revision.
- **lockMac** (string) - The MAC address of the lock.
- **lockName** (string) - The name of the lock.
- **modelNum** (string) - The model number.
- **featureValue** (string) - The feature value.
- **hasGateway** (integer) - Indicates if the lock has a gateway.
- **autoLockTime** (integer) - The auto-lock time in seconds.
- **resetButton** (integer) - Whether the reset button is enabled.
- **firmwareRevision** (string) - The firmware revision.
- **tamperAlert** (integer) - Tamper alert status.
- **noKeyPwd** (string) - The no-key password.
- **passageMode** (integer) - Passage mode setting.
- **passageModeAutoUnlock** (integer) - Passage mode auto unlock setting.
- **timezoneRawOffset** (integer) - The timezone raw offset in milliseconds.
- **lockId** (integer) - The ID of the lock.
- **electricQuantity** (integer) - The battery level.
- **hardwareRevision** (string) - The hardware revision.
- **lockSound** (integer) - The lock sound setting.
- **modelNum** (string) - The model number.
- **lockMac** (string) - The MAC address of the lock.
- **privacyLock** (integer) - The privacy lock setting.
- **featureValue** (string) - The feature value.
- **soundVolume** (integer) - The sound volume.
- **hasGateway** (integer) - Whether the lock has a gateway.
- **autoLockTime** (integer) - The auto-lock time.
- **lockName** (string) - The lock name.
- **resetButton** (integer) - Whether the reset button is enabled.
- **firmwareRevision** (string) - The firmware revision.
- **tamperAlert** (integer) - Whether tamper alert is enabled.
- **noKeyPwd** (string) - The no-key password.
- **passageMode** (integer) - The passage mode.
- **passageModeAutoUnlock** (integer) - The passage mode auto unlock setting.
- **timezoneRawOffset** (integer) - The timezone raw offset in milliseconds.
- **lockId** (integer) - The lock ID.
- **electricQuantity** (integer) - The battery level.
- **hardwareRevision** (string) - The hardware revision.

#### Response Example
```json
{
  "date": 1749195089000,
  "lockAlias": "S202F_55ce63",
  "lockSound": 1,
  "modelNum": "SN284-FINGER-T0_PV53",
  "lockMac": "ED:AE:90:63:CE:55",
  "privacyLock": 2,
  "featureValue": "344CD5F7",
  "soundVolume": 5,
  "hasGateway": 0,
  "autoLockTime": 5,
  "lockName": "S202F_55ce63",
  "resetButton": 1,
  "firmwareRevision": "5.1.0.200705",
  "tamperAlert": 1,
  "noKeyPwd": "7780189",
  "passageMode": 2,
  "passageModeAutoUnlock": 2,
  "timezoneRawOffset": 28800000,
  "lockId": 3466251,
  "electricQuantity": 100,
  "hardwareRevision": "1.1"
}
```
```
Tokens:
Raw