批量发送钥匙
https://euapi.ttlock.com/v3/key/batchSend
管理员给用户批量发送多把锁的电子钥匙。
接收用户可登录通通锁APP获取电子钥匙开锁;如果开发者需要对接APP SDK开发自己的APP实现电子钥匙开锁,可用receiverUsername对应的账号获取访问令牌,用相应的令牌调用获取名下钥匙列表接口获取电子钥匙。
receiverUsername 为在通通锁APP上注册的用户或通过注册用户接口注册的用户(请使用接口返回的带前缀的username)。如果receiverUsername是尚未注册的手机号或电子邮箱,加传createUser=1会自动创建对应的通通锁账号,默认密码为账号的后六位字符,例如receiverUsername为18876191905,则默认密码为191905。
一个用户针对一把锁,最多只允许有一把电子钥匙,如果之前已经拥有当前锁的电子钥匙,再调用该接口给其发送,则之前的钥匙将被删除,再生成一把新钥匙。
不能给自己发送电子钥匙,也不能给最高管理员发送电子钥匙。
1 HTTP请求方法及示例
POST, ContentType:application/x-www-form-urlencoded
javascript
curl --location -g --request POST 'https://euapi.ttlock.com/v3/key/batchSend' \
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
--data-urlencode 'lockIdList=[163377,163379]' \
--data-urlencode 'receiverUsername=18876191905' \
--data-urlencode 'keyName=陈文亮' \
--data-urlencode 'startDate=1625025703000' \
--data-urlencode 'endDate=1635025703000' \
--data-urlencode 'createUser=1' \
--data-urlencode 'remarks=水费月底待交' \
--data-urlencode 'date=1625025703000'2 参数说明
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| clientId | String | Y | 创建应用分配的client_id |
| accessToken | String | Y | 访问令牌,通过获取访问令牌接口获取 |
| groupIdIdList | String | N | 分组ID列表, |
| lockIdList | String | N | 锁ID列表,由锁初始化接口生成 |
| receiverUsername | String | Y | 接收方用户名 |
| keyName | String | Y | 钥匙名 |
| startDate | Long | Y | 有效期开始时间(时间戳,单位毫秒) |
| endDate | Long | Y | 有效期结束时间(时间戳,单位毫秒) |
| remarks | String | N | 备注,留言 |
| remoteEnable | Int | N | 是否支持远程开锁:1-是、2-否 |
| keyRight | Int | N | 是否授权管理员钥匙: 1-是、0-否,默认不授权 |
| createUser | Int | N | 是否自动创建通通锁账号:1-是,2-否(默认2), 该参数只在receiverUsername为邮箱或手机号时生效。 |
| date | Long | Y | 当前时间(时间戳,单位毫秒) |
3 返回参数及示例
| 参数 | 类型 | 描述 |
|---|---|---|
| receiverUid | Int | 接收用户ID |
| list | JSONArray | 钥匙列表 |
{
"list": [
{
"lockId": 163377,
"keyId": 62502570
},
{
"lockId": 163379,
"keyId": 62502571
}
]
}