获取锁名下人脸列表
https://cnapi.ttlock.com/v3/face/list
管理员或授权管理员查看这把锁上,添加的所有人脸。
1 HTTP请求方法及示例
javascript
curl --location -g --request GET 'https://cnapi.ttlock.com/v3/face/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'2 参数说明
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| clientId | String | Y | 创建应用分配的client_id |
| accessToken | String | Y | 访问令牌,通过获取访问令牌接口获取 |
| lockId | Int | Y | 锁ID,由锁初始化接口生成 |
| searchStr | String | N | 搜索串(名称模糊匹配) |
| pageNo | Int | Y | 页码,从1开始 |
| pageSize | Int | Y | 每页数量,默认20,最大200 |
| date | Long | Y | 当前时间(时间戳,单位毫秒) |
3 返回参数及示例
| 参数 | 类型 | 描述 |
|---|---|---|
| list | JSONArray | 记录列表 |
| pageNo | Int | 页码,从1开始 |
| pageSize | Int | 每页数量,最大200 |
| pages | Int | 总页数 |
| total | Int | 总条数 |
列表中的对象
| 参数 | 类型 | 描述 |
|---|---|---|
| faceId | Int | 人脸ID |
| lockId | Int | 锁ID |
| name | String | 人脸名称 |
| faceNumber | String | 人脸编号 |
| status | String | 状态:1-正常、2-已失效、3-待生效 |
| nickname | String | 添加者昵称 |
| userid | String | 添加者uid |
| type | Int | 人脸类型:1-普通、4-循环 |
| startDate | Long | 有效期开始时间(时间戳,单位毫秒) |
| endDate | Long | 有效期结束时间(时间戳,单位毫秒) |
| cyclicConfig | JSONArray | 循环时间设置,目前只支持每天开始时间和结束时间一样的设置,示例: {"startTime":480, "endTime":1080,"weekDay":[1,2,3,4,5]} 表示周一到周五8:00到18:00有效 |
| createDate | Long | 创建时间(时间戳,单位毫秒) |
{
"list": [
{
"faceId": 224242,
"lockId": 163377,
"faceNumber": "44668054142981",
"faceType": 1,
"faceName":"妈妈的正脸",
"startDate": 1625025703000,
"endDate": 1645025703000,
"createDate": 1625025703000,
"nick": "alexa@google.com"
}
],
"pageNo":1,
"pageSize":20,
"pages":1,
"total":1
}