透传人脸权限下发
- 接口功能
向指定设备透传下发人脸;
同一时间,一个智能锁只允许被一个用户操作;
- 请求地址
https://open.ys7.com/api/component/saas/smartlock/person/face/add
- 请求方式
POST
- 参数列表
参数名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
accessToken | String | 开放平台授权获取的访问令牌 | Y |
employeeNo | String | 工号(32位数字和字母构成,建议UUID随机生成,防止重复;如不足32位,请勿使用0开头,可能会影响部分功能) | Y |
deviceSerial | String | 智能锁序列号 | Y |
faceImageUrl | String | 人脸图片地址 | Y |
extension | Object | 权限时间相关(不填默认最长时间:2037-12-31 23:59:59) | N |
extension.validEnable | String | 是否校验有效期(0-校验;1-不校验) | N |
extension.beginTime | String | 开始时间(validEnable为1时可不填,格式为:yyyy-MM-dd HH:mm:dd) | N |
extension.endTime | String | 结束时间(validEnable为1时可不填,格式为:yyyy-MM-dd HH:mm:dd) | N |
- 请求报文
POST https://open.ys7.com/api/component/saas/smartlock/person/face/add HTTP/1.1
Host: open.ys7.com
content-type: application/x-www-form-urlencoded
accessToken=at.29jzy7vi88yfsuh85io56p9i4dkqsb0d-8z5uqcucl2-1fhh9lp-xh6a59hqv&deviceSerial=K03323778&employeeNo=aaaaaaaaaaaaa111111111112&faceImageUrl=https%3A%2F%2Fsaas-client.oss-cn-beijing.aliyuncs.com%2Fe384%2F34ec81e5-5924-4ab0-bca3-5fd86dab7bde.jpg&extension.validEnable=0&extension.beginTime=2023-01-15%2000%3A00%3A00&extension.endTime=2023-02-23%2000%3A00%3A00
- 返回数据
{
"code": "200",
"data": [
{
"cmdId": "QQuvLGwdJxdRqYxzTEocRF",
"code": "10",
"operation": "person"
},
{
"cmdId": "94RjXPs8enQXcfX3GqWT29",
"code": "200",
"msg": "操作成功",
"operation": "face"
}
],
"msg": "操作成功"
}
- 参数说明
参数名 | 类型 | 描述 | 是否必须 |
---|---|---|---|
code | int | 状态码-200,表示通过云端校验,成功开始与设备交互; 权限是否下发成功请根据data中authorityStatus判断 |
Y |
msg | String | 具体错误描述信息 | Y |
data | Object[] | 业务结果 | N |
data[i].cmdId | String | NB设备指令id | N |
data[i].code | String | 指令下发状态码:1-成功;10-下发中;其它-失败 | N |
data[i].msg | String | 指令下发状态描述 | N |
data[i].operation | String | 具体操作:person-人员;password-密码;card-卡;face-人脸;finger-指纹(指纹会分包) | N |