Open Platform
Skip to content

Add door sensor ​

https://cnapi.ttlock.com/v3/doorSensor/add

Request this endpoint after you successfully added a door sensor to the lock via APP SDK.

1 Request example ​

POST, ContentType:application/x-www-form-urlencoded

javascript
curl --location -g --request POST 'https://cnapi.ttlock.com/v3/doorSensor/add' \
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
--data-urlencode 'lockId=163377' \
--data-urlencode 'name=Door sensor for front door' \
--data-urlencode 'mac=C9:27:AB:43:22:80' \
--data-urlencode 'firmwareInfo={"modelNum":"SN405_LR","hardwareRevision":"1.3","firmwareRevision":"1.0.0.210903"}' \
--data-urlencode 'number=DS2_a961c2' \
--data-urlencode 'electricQuantity=85' \
--data-urlencode 'date=1625025703000'

2 Request parameters ​

NameTypeRequiredDescription
clientIdStringYclient_id from Create application
accessTokenStringYAccess token,refer to: Get access token
lockIdIntYLock ID, generated by Lock init
nameStringNDoor sensor name
electricQuantityIntYDoor sensor battery level
firmwareInfoJSONObjectYDoor sensor firmware verion info
macStringYDoor sensor MAC
numberStringYDoor sensor number
dateLongYCurrent time (timestamp in millisecond)

firmwareInfo:

ParameterTypeDescription
modelNumStringModel number
hardwareRevisionStringhardware revision
firmwareRevisionStringfirmware revision

3 Response and example ​

ParameterTypeDescription
doorSensorIdIntDoor sensor ID
{
    "doorSensorId": 34242
}
CopyRight © 2012-2026 TTLock.All Rights Reserved