Skip to content

添加人脸 ​

https://euapi.ttlock.com/v3/face/add 向锁里添加人脸,添加成功后可以用人脸进行开锁,主要有两种添加方式:

(1)通过APP或者蓝牙连接锁添加: ​

开发者可以通过SDK添加人脸,再调用该接口(addType传1)将录入的人脸上同步到云端,方便后续管理。

(2)通过网关或WiFi锁远程添加: ​

如果是WiFi锁或连有网关的设备,可以调用该接口(addType传2)远程添加人脸。

锁特征支持第124位的锁,人脸照片下发:

  • 照片下发需要先通过获取锁额外设置信息接口获取到锁内支持设置的图片信息(比如,长宽,大小,类型)。
  • 对图片进行调整后,开发者将图片上传到自己的图片服务器上,将图片的URL作为本接口入参。
  • 人脸添加成功后,开发者可自行决定是否从自己服务器上删除照片。

1 HTTP请求方法及示例 ​

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

javascript
curl --location -g --request POST 'https://euapi.ttlock.com/v3/face/add' \
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
--data-urlencode 'lockId=163377' \
--data-urlencode 'name=妈妈的正脸' \
--data-urlencode 'startDate=1625025703000' \
--data-urlencode 'endDate=1645025703000' \
--data-urlencode 'type=1' \
--data-urlencode 'featureData=F0E41DEAEDF7F31420D5F6FD0403ECF0F4EEF7E6010BF3E5EDEDE5E6F4ED1006FBEDFF02DFF4F3EB09DEF408D6FEE7061616FFFF0008FCE807F6040DF01116FAFFF112DEF9180600FE00F5F41126FCE70CE0071401F715F9FDDF0EEBFB1CFA0BF112FF0E040619010FFCC6DCFBFFD0FFF5EAF600FEF4081E15FF03ECEF1705FC05E0120AEDFCF304ED16F2DF0610FDF4060FFBE1E70CF0FD10EA04EEEB080E0E1117F5F3EF05010D0E02FB0EEBF70F01101507F6F20CFBFBF8162836010BFAFD0603E7F519EFFEF4D514EAFF0107DFEF05F519FC0A08FC11FEFEF3FC0E00FCFB0602F0F20809F6020EF00E0EFD01F2FEF70723E100F10AFFF6D7EBF5FBF7ECF7' \
--data-urlencode 'addType=2' \
--data-urlencode 'date=1625025703000'

2 参数说明 ​

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockIdIntY锁ID,由锁初始化接口生成
nameStringN人脸名称
faceNumberStringN人脸编号
通过APP SDK在锁上添加时,SDK成功回调会返回人脸编号;
通过网关或WiFi锁远程添加时,该参数不传
startDateLongY有效期开始时间(时间戳,单位毫秒), startDate和endDate都传0 表示永久有效
endDateLongY有效期结束时间(时间戳,单位毫秒), startDate和endDate都传0 表示永久有效
typeIntN1-普通,4-循环(不传默认1)
cyclicConfigJsonArrayN循环操作时间设置(循环类型的才需要传)
featureDataStringN人脸特征值数据,通过人脸照片获取人脸特征值接口获取,远程添加时需要传
urlStringN人脸图片URL,远程添加时(addType传2)可传;需锁特征值第124位表示支持人脸照片下发,不支持时返回"此锁不支持该功能"
addTypeIntY添加方式:
1-通过APP蓝牙添加,不传则默认1,必需先通过APP蓝牙添加后再调用该接口
2-通过网关或WiFi锁远程添加,如果是WiFi锁或有连接网关,则可以传2,直接调用该接口添加到锁里
dateLongY当前时间(时间戳,单位毫秒)

cyclicConfig中的参数:

参数类型描述
startTimeInt开始时间,分钟数, 例如 480 代表 8:00
endTimeInt结束时间,分钟数, 例如 1080 代表 18:00
weekDayInt星期:1-7, 1-星期一...7-星期天

3 返回参数及示例 ​

参数类型描述
faceIdInt人脸ID
{
    "faceId": 124242
}