Get additional lock settings information
https://cnapi.ttlock.com/v3/lock/getExtraSetting
This mainly includes information such as unauthorized alarms.
If no data is found when querying the cloud for unauthorized alarm information, you need to obtain the latest unauthorized alarm information through the Bluetooth APP SDK, gateway, or Wi-Fi lock channel.
1 Request example
POST, ContentType:application/x-www-form-urlencoded
javascript
curl --location -g --request POST 'https://cnapi.ttlock.com/v3/lock/getExtraSetting' \
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
--data-urlencode 'lockId=3001' \
--data-urlencode 'date=1625025703000'
--data-urlencode 'type=1'2 Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
| clientId | String | Y | Client_id from Create application |
| accessToken | String | Y | Access token,refer to: Get access token |
| lockId | Int | Y | Lock ID |
| type | Int | Y | 0 - Retrieve information from the cloud 1 - Retrieve the latest unauthorized alarm information via gateway or Wi-Fi lock |
| date | Long | Y | Current time (timestamp, in milliseconds) |
3 Response and example
| Parameter | Type | Description |
|---|---|---|
| unauthorizedAttemptAlertFlag | Int | Unauthorized alarm, 1 - On, 0 - Off |
| unauthorizedAttemptAlertCount | Int | Unauthorized alerts, number of failures, 0 indicates off. |
| unauthorizedAttemptAlertLockTime | Int | Unauthorized alarm, lock time, unit - seconds |
| unauthorizedAttemptAlertPwd | Int | Unauthorized alarm, password flag: 1 - on, 0 - off |
| unauthorizedAttemptAlertCard | Int | Unauthorized alarm, IC card flag: 1 - On, 0 - Off |
| unauthorizedAttemptAlertFingerprint | Int | Unauthorized access alarm, fingerprint indicator, 1 - open, 0 - closed |
| faceImageSize | Int | The URL of the face photo is sent with the following parameters: image size (unit: KB). |
| faceImageHeight | Int | The URL of the face photo is sent with the following parameters: image height (in pixels). |
| faceImageWidth | Int | The URL for the face photo should be sent with the following parameters: image width in pixels. |
| faceImageType | Int | The URL of the face photo should be sent with the following parameters: image type 1-JPG. |
| wifiFirmwareRevision | String | Wi-Fi firmware version |
{
"unauthorizedAttemptAlertPwd": 1,
"unauthorizedAttemptAlertFingerprint": 1,
"unauthorizedAttemptAlertCount": 5,
"unauthorizedAttemptAlertCard": 1,
"unauthorizedAttemptAlertFlag": 1,
"unauthorizedAttemptAlertLockTime": 1,
"faceImageType": 1,
"faceImageWidth": 720,
"faceImageSize": 512,
"faceImageHeight": 1280,
"wifiFirmwareRevision": "1.0.3"
}