锁设置

获取所有设置

1. 请求链接: /lockSetting/getLockSetting

2. 请求方式: GET

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

说明: 参数列表参阅 附件文档

{
  "lockId": 500,
  "lockSetting": {
    "remoteUnlock": 0,
    "autoLock": 0,
    "autoLockSecond": 20,
    "antiPrySwitch": 1,
    "resetSwitch": 1,
    "lockSwitch": 1,
    "lockSound": 1,
    "lockSoundVolume": 2,
    "languageSettingLang": 1,
    "openDirectionValue": 1,
    "doorNotClosedAlarm": 1,
    "unlockReminder": 1,
    "lightingTime": 1,
    "lightingSecond": 10,
    "passageMode": 0,
    "passageModeConfig": [],
    "attendance": 0,
    "appUnlockOnline": 0,
    "bluetoothBroadcast": 1,
    "adminPwd": "sAacQHa33dfzNKYyirN7lVLWVzLavbrUbSYSFpaJ",
    "unlockReminderPush": 1,
    "languageSettingLangText": "简体中文"
  }
}

设置远程开锁

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
remoteUnlock	int	Y	0/1	远程开锁开关

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置自动闭锁

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
autoLock	int	Y	0/1	自动闭锁开关
autoLockSecond	int	Y	20	自动闭锁秒数

4. 返回参数及示例:

参数	类型	描述
lockId	Int	锁ID
autoLock	Int	自动闭锁开关

说明: 响应返回所有锁设置

设置防撬开关

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
antiPrySwitch	int	Y	0/1	防撬开关配置(启用/禁用)

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置重置键

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
resetSwitch	int	Y	0/1	重置键配置(启用/禁用)

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置反锁功能

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
lockSwitch	int	Y	0/1	反锁功能配置(启用/禁用)

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置语音提示

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
lockSound	int	Y	0/1	语音提示管理(启用/禁用)
lockSoundVolume	int	Y	0-5	音量大小（全局）

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置语言

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
languageSettingLang	int	Y	1	语言代号，参考常量列表

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置开门方向

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
openDirectionValue	int	Y	1	开门方向：1-左开、2-右开

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置未关报警

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
doorNotClosedAlarm	int	Y	0/1	门未关报警(启用/禁用)

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置开锁提醒(锁本地提示音)

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
unlockReminder	int	Y	0/1	开锁提醒(启用/禁用)（锁本地提醒音）

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置照明灯开关

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
lightingTime	int	Y	0/1	照明灯开关
lightingSecond	int	Y	5~60	照明灯秒数

4. 返回参数及示例:

说明: 响应返回所有锁设置

设置常开模式

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
passageMode	int	Y	0/1	常开模式-开关
passageModeConfig	Object	Y	[]	常开模式-时间周期配置，json数组，参考 附件文档

4. 返回参数及示例:

说明: 响应返回所有锁设置

考勤开关（废弃）

1. 请求链接: /v2/lockSetting/updateLockSetting

2. 请求方式: POST

说明: 此接口已废弃

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
attendance	int	Y	0/1	考勤开关

4. 返回参数及示例:

说明: 响应返回所有锁设置

APP开锁时是否需联网

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
appUnlockOnline	int	Y	0/1	APP开锁时是否需联网

4. 返回参数及示例:

说明: 响应返回所有锁设置

蓝牙广播

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
bluetoothBroadcast	int	Y	0/1	蓝牙广播（只是影响安全性，不影响功能）

4. 返回参数及示例:

说明: 响应返回所有锁设置

管理员开锁密码

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
adminPwd	String	Y	"123456"	管理员开锁密码

4. 返回参数及示例:

说明: 响应返回所有锁设置

开锁提醒开关

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
unlockReminderPush	int	Y	0/1	开锁提醒开关

4. 返回参数及示例:

说明: 响应返回所有锁设置

更新锁所有设置项

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
remoteUnlock	int	N	0	远程开锁开关 0/1
remoteCloseLock	int	N	0	远程闭锁开关(启用/禁用)
autoLock	int	N	0	自动闭锁开关
autoLockSecond	int	N	5	自动闭锁秒数
antiPrySwitch	int	N	0	防撬开关配置(启用/禁用)
resetSwitch	int	N	0	重置键配置(启用/禁用)
lockSwitch	int	N	0	反锁功能配置(启用/禁用)
lockSound	int	N	0	语音提示管理(音量大小/禁用)
lockSoundVolume	int	N	5	音量大小
languageSettingLang	int	N	1	语言编号
openDirectionValue	int	N	1	开门方向
doorNotClosedAlarm	int	N	1	门未关报警(启用/禁用)
unlockReminder	int	N	1	开锁提醒(启用/禁用)
lightingTime	int	N	1	照明灯开关
lightingSecond	int	N	10	照明灯秒数
passageMode	int	N	0	常开模式-开关
passageModeConfig	array	N	[]	常开模式-时间周期配置数组
attendance	int	N	0	考勤开关(线上设置)
appUnlockOnline	int	N	0	APP开锁时是否需联网
bluetoothBroadcast	int	N	0	蓝牙广播（关闭则不能使用蓝牙主动开锁）
adminPwd	String	N	""	管理员开锁密码
unlockReminderPush	int	N	0	开锁提醒推送
motorTorsion	int	N	1	电机扭力(1：小，2：中，3：大)
stayWarn	int	N	0	逗留警告(启用/禁用)
abnormalWarn	int	N	0	异常警告(启用/禁用)
faceSwitch	int	N	0	人脸开关 0:关闭 1:开启
faceAutoLightScreen	int	N	0	人脸自动亮屏开关 0:关闭 1:开启
faceInductionDistance	int	N	2	人脸感应距离（0：关闭，1：近距离，2：中距离，3：远距离）
faceAntiMistakeOpen	int	N	0	人脸防误开门 0:关闭 1:开启
autoLightScreen	int	N	0	自动亮屏开关 0:关闭 1:开启
autoLightScreenTime	int	N	10	自动亮屏时间
dayNotOpenDoorSwitch	int	N	0	N天未开门开关 (启用/禁用)
dayNotOpenDoorValue	int	N	0	N天未开门值
doorNotCloseSwitch	int	N	0	门未关闭开关 (启用/禁用)
lowElecNoticeSwitch	int	N	0	低电量开关 (启用/禁用)
doorbellNoticeSwitch	int	N	0	有人按门铃开关 (启用/禁用)
network	String	N	""	配网信息

4. 返回参数及示例:

说明: 响应返回所有锁设置

更新网络信息（废弃）

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

说明: 此接口已废弃，请使用 4.0.1 设备-设置配网

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
network	String	Y	""	网络信息

4. 返回参数及示例:

说明: 响应返回所有锁设置

更新设置（通用-按需更新）

1. 请求链接: /lockSetting/updateLockSetting

2. 请求方式: POST

说明: 请使用 4.0.1 设备-设置配网

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	1001	锁ID
proximityRange	int	N	0	接近感应 0:关闭 1:近 2:中 3:远

4. 返回参数及示例:

说明: 响应返回所有锁设置

锁时间

1. 请求链接: /room/queryDate

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

成功示例:

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

失败示例（没有网关时）:

说明: 没有网关的时候返回如下显示信息，但也有时间显示，通过蓝牙读取。

{
  "errorCode": -2012,
  "description": "锁附近没有可用的网关",
  "errorMsg": "The Lock is not connected to any Gateway."
}

校准时间

1. 请求链接: /check/getServerDatetime

2. 请求方式: POST

3. 参数说明:

无参数

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "date": 1689410340445
}

夏令时模式设置

说明: 接口待补充

诊断

1. 请求链接: /room/uploadLockInfo

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID
electricQuantity	String	Y	"23"	电量
firmware	String	Y	"6.5.07.220617"	固件版本
hardware	String	Y	"1.3"	硬件版本
lockDate	String	Y	"1689410557000"	锁时间
modelNum	String	Y	"SN452-CSK14T_PV53"	型号
pwdInfo	String	Y	"3HjQn7v9KfHsabpxo79/BqvBtTKjRSbcK2gNaCvxV39KXV/HwxV0RJwJcFfgIplXOfq4sOnHyja7BbEW7v/GNeN3XyG4hR7Aw8HuFXT%2BORE%3D"	密码信息
timestamp	String	Y	"1689410559456000"	时间戳

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "date": 1689410340445
}

导入其他锁数据

1. 请求链接: /room/getImportData

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	目标锁ID
fromLockId	String	Y	"9418451"	源锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "keyboardPwdNum": 0,
  "cardNum": 0,
  "identityCardList": [],
  "keyNum": 1,
  "keyboardPwdList": []
}

导入数据成功

1. 请求链接: /room/importSuccess

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	目标锁ID
fromLockId	String	Y	"9418451"	源锁ID
cardIdList	String	Y	"[]"	卡ID列表
keyboardPwdIdList	String	Y	"[]"	密码ID列表

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

锁升级

1. 请求链接: /room/update

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "decryptionKey": "1687314197540000",
  "modelNum": "SN452-CSK14T_PV53",
  "hardwareRevision": "1.3",
  "needUpdate": 1,
  "firmwarePackage": "LTU2LC0xMTEsLTQxLC00MiwtNDgsLTYzLC01NCwtNjEsLTU3LC0zOCwtMzYsLTM1LC04LC00MiwtNTQsLTExMSwtMTE5LC0xMTEsLTEyNiwtMTIzLC0xMTcsLTEyNCwtMTI4LC0xMjYsLTEyMSwtMTI2LC0xMTgsLTEyNCwtMTIyLC0xMjEsLTEyNSwtMTI1LC0xMjUsLTEyNSwtMTExLC05NywtMTExLC01OCwtNjMsLTMzLC0xMTEsLTExOSwtMTExLC0zNywtNTcsLTU3LC02MSwtMTE5LC0xMDAsLTEwMCwtNjIsLTM4LC0zNSwtMzgsLTU4LC02MSwtNDYsLTQ4LC00MCwtNDYsLTQ0LC00MiwtOTksLTY0LC00OCwtMzgsLTQyLC0zNSwtNDIsLTYzLC05OSwtNDgsLTM1LC0xMDAsLTQzLC0zOCwtNjMsLTM0LC02MCwtNDYsLTYzLC00MiwtMTAwLC0zMiwtMywtMjAsLTEyMSwtMTIyLC0xMjcsLTIwLC0yNywtMTI2LC05OSwtMTI4LC05OSwtMTI1LC0xMDEsLTEwMSwtMiwtMTYsLTE1LC0zLC0xMjUsLTEyNiwtMTAyLC0yMCwtMTAxLC0zMiwtMywtMTIxLC0xMjIsLTEyNywtOTgsLTE2LC0zMiwtOCwtMTI2LC0xMjEsLTI1LC0xMDIsLTEwMiwtMjAsLTI3LC0xMjMsLTk5LC0xMjIsLTk5LC0xMjUsLTExNywtOTksLTEyNywtMTI4LC0xMjUsLTEyMywtMTI1LC0xMjcsLTk5LC00NywtMzgsLTM1LC0xMTEsLTUwLDMy",
  "version": "6.5.08.230602",
  "releaseNote": "lock firmware update",
  "url": "http://qiniupackage.sciener.cn/firmware/SN_452_V1.3.0((MCBN01)_(SN452-CSK14T))_V6.5.08.230602.bin",
  "firmwareRevision": "6.5.07.220617"
}

Amazon Alexa/Google Home 更新是否远程开锁的值

1. 请求链接: /room/updateSpecialValue

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
featureValue	String	Y	"C2F44354CF1F7"	特征值
lockId	String	Y	"9418481"	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

考勤

1. 请求链接: /attendanceCompany/isExistenceCompany

2. 请求方式: POST

说明: 路径已改为：/attendanceCompany/isExistenceCompany（原路径：/companyForSciener/isExistenceCompany）

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

无公司时返回:

{
  "workEndTime": 0,
  "attendanceType": 0,
  "companyId": 0,
  "workStartTime": 0,
  "workDay": "1,2,3,4,5"
}

有公司时返回:

{
  "companyId": 80615
}

说明: 如果有公司，同时需要调用 /room/updateSetting 接口设置考勤开启，提交参数如下：

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID
isOn	String	Y	"1"	是否开启
type	int	Y	1	考勤为1

设置考勤时创建公司

1. 请求链接: /v2/attendanceCompany/add

2. 请求方式: POST

说明: 路径已改为：/v2/attendanceCompany/add（原路径：/companyForSciener/add）

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID
attendanceType	int	Y	0	设置类型，0为自定义，1为单双休
companyName	String	Y	"如画科技"	公司名称
workDay	array	Y	[1,2,3,4,5]	工作日
workEndTime	long	Y	1692870240000	结束时间
workStartTime	long	Y	1692838800000	开始时间

说明: 当前提交时间的日期与时间相结合，只取时间即可，日期不用理会。

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

开锁提醒（废弃）

1. 请求链接: /key/updateMonitorFlag

2. 请求方式: POST

说明: 此接口已废弃

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID
keyId	String	Y	"106932103"	钥匙ID
monitorFlag	String	Y	"1"	1开启，2关闭

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

删除电子钥匙（钥匙为授权管理员调用）

1. 请求链接: /key/delete

2. 请求方式: POST

说明: 钥匙为授权管理员时调用

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID
keyId	String	Y	"109751233"	钥匙ID
includeUnderlings	int	N	0	是否删除授权管理员下的钥匙：授权管理员下可传

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

手机联网token生成

1. 请求链接: /lock/getLockNetToken

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockId	String	Y	"9418481"	锁ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "token": "4463771293940318"
}

批量设置锁是否需要联网

1. 请求链接: /lockSetting/batchUpdateLockOnlineUnlock

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
lockIds	array	Y	[500,5001]	锁ID数组
onlineUnlock	int	Y	0	是否联网开锁：1是 0否

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}