Skip to content

循环、单次、永久电子钥匙说明 ​

一、发送循环或单次钥匙 ​

还是调用发送钥匙接口: https://euapi.ttlock.com/v3/key/send

发送单次钥匙endDate传1,其他参数和发送限时钥匙相同,通通锁APP目前的逻辑是单次钥匙开锁后直接把钥匙从本地删除,并且调用云端删除钥匙的接口;

发送永久钥匙startDate和endDate传0,其他参数和发送限时钥匙相同;

发送循环钥匙startDate和endDate和发送限时钥匙不同,另外增加keyType, weekDays, startDay, endDay四个参数,循环钥匙是否有效由APP本地判断,修改循环钥匙有效期增加weekDays, startDay, endDay三个参数,发送循环钥匙请求参数详情如下表所示:

1 发送循环钥匙参数说明 ​

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockIdIntY锁ID,由锁初始化接口生成
receiverUsernameStringY接收方用户名
keyNameStringY钥匙名
startDateLongY有效期开始时间(时间戳,单位毫秒),取当前日期相应时间的时间戳,比如9点开始,则取当天9点的时间戳
endDateLongY有效期结束时间(时间戳,单位毫秒),取当前日期相应时间的时间戳,比如18点结束,则取当天18点的时间戳
remarksStringN备注,留言
remoteEnableIntN是否支持远程开锁:1-是、2-否
keyRightIntN是否授权管理员钥匙: 1-是、0-否,默认不授权
createUserIntN是否自动创建通通锁账号:1-是,2-否(默认2), 该参数只在receiverUsername为邮箱或手机号时生效。
keyTypeIntN钥匙类型:4-循环钥匙
weekDaysJsonArray[Int]N循环钥匙有效星期,示例:[1,2,3], 表示星期天、星期一、星期二有效,注意1表示星期天
startDayLongN循环钥匙有效期开始日期(时间戳,单位毫秒),取生效开始日期00:00:00的时间戳
endDayLongN循环钥匙有效期结束日期(时间戳,单位毫秒),取生效结束日期23:59:59的时间戳
dateLongY当前时间(时间戳,单位毫秒)

2 循环钥匙在获取钥匙相关接口返回参数变更 ​

获取名下钥匙列表,获取单把钥匙,获取锁的钥匙列表 三个接口循环钥匙会增加返回以下参数:

名称类型描述
keyTypeInt钥匙类型:4-循环钥匙
weekDaysJsonArray[Int]循环钥匙有效星期
startDayLong循环钥匙有效期开始日期(时间戳,单位毫秒),取生效开始日期00:00:00的时间戳
endDayLong循环钥匙有效期结束日期(时间戳,单位毫秒),取生效结束日期23:59:59的时间戳