接口说明:

  • 下发自定义密码
  • 房间封房状态不能下发密码
1.门锁绑定网关

业务能力:

  • openSmartDownSendPasswordKey

本地服务器版本:

  • V3.2.0

Content-Version:

  • 1.0

参数:

参数名层级类型条件描述备注
lockCode1String必填门锁号可通过房间列表查看
customerName1String必填房客名称--
password1String必填密码6~16位数字
copyCheckIn1int必填复制入住本地服务器V1.4.5版本:
0 不复制入住,开始时间取推送过来入住的当前时间,且对房间做退房逻辑
1 复制入住,存在房客入住以房客最早开始时间为准

本地服务器V1.5.0版本:
0 退房后入住
先将对应房源内的所有房客退房(删除授权)再入住(执行当前的新授权),取入参开始时间作为本次入住授权的起始时间(时间精度为小时)
1 立即入住
不删除对应房源内的原有授权,以已入住房客授权的开始时间作为本次入住授权的开始时间,如对应房源内没有已入住的房客,则取当前时间作为本次入住授权的开始时间(时间精度为小时)
2 其他时间入住
不删除对应房源内的原有授权,取入参开始时间作为本次入住授权的起始时间(可以为未来时间,时间精度为小时)
备注:
房间门锁开启顶替功能,如果入住时间触发其他授权顶替,服务器则会有异常提示,第三方需要调整入住时间。
如若该门锁号为门禁时,只能选1和2。
房间开启顶替的情况下,该接口只能选0进行入住。
idType1int可选证件类型1身份证
2护照
9其他
idNumber1String可选证件号最大支持100个字符
beginTime1long必填开始时间时间戳,单位秒
endTime1long必填结束时间时间戳,单位秒
authorMode1int可选有效期授权方式1:有效期授权
2:周期重复时间段授权
默认为1
weeks1int可选星期数AuthorMode = 0x02有效
按位域bit0~bit6分别表示,对应bit位数置1,则表示当天钥匙有效
例如:二进制1001011就表示周日,周四,周二,周一
dayStartTimes1String可选每日起始时间格式:HH:mm
dayEndTimes1String可选每日结束时间格式:HH:mm
useNum1int使用次数每日结束时间不填或0表示无限次
限制次数,最大是254次
authChannel1int可选授权通道0或空 不授权通道锁
1 授权通道锁(不存在通道锁不会授权)
delaySend1int可选是否延时下发1: 延时下发
非1 或 空 默认下发方式

请求示例

{
	"tokenId": "aFqJ9GbjlmX0LHZosmciPH3Ewt4S53Fdt/AX7/to/I8IDaYsFkk1cIkz5Ez2Y/PvhDDKWppSuXv1QLcPyLjF+g==",
	"method": "openSmartDownSendPasswordKey",
	"data": {
		"lockCode": "1.2.201A",
		"customerName":"zzy",
		"copyCheckIn":0,
		"idType":1,
		"idNumber":"1231231",
		"beginTime":1602165958,
		"endTime":1608965958,
		"password":"123456"
	}
}

响应示例

{
	"msgId": 77568002,
	"resultCode": 0,
	"reason": "",
	"method": "openSmartDownSendCardKey",
	"data": {
		"checkInId": "h0JYf4V93p4=",
		"checkInName": "zzy",
		"beginTime": 1602165600,
		"endTime": 1608965958,
		"idType": 1,
		"idNumber": "1231231",
		"password": "123456"
	}
}

响应参数说明

参数名层级类型条件描述备注
checkInId1String必填入住ID--
checkInName1String必填用户姓名--
idType1int可选证件类型1身份证
2护照
9其他
idNumber1String可选证件号--
beginTime1int必填开始时间时间戳:单位秒
endTime1int必填结束时间时间戳:单位秒
authorMode1int可选有效期授权方式1:有效期授权
2:周期重复时间段授权
默认为1
weeks1int可选星期数AuthorMode = 0x02有效
按位域bit0~bit6分别表示,对应bit位数置1,则表示当天钥匙有效
例如:二进制1001011就表示周日,周四,周二,周一
dayStartTimes1String可选每日起始时间格式:01:00
dayEndTimes1String可选每日结束时间格式:02:00
useNum1int可选使用次数不填或255表示无限次
限制次数,最大是254次
cardNo1String必填卡号--
auth1list可选授权详情服务器2.4.0版本新增
relaId2String必填联动授权关系ID
channelType2Int必填通道类型5大门
6楼栋
7楼层
8房间
9套房
roomName2String必填房间名称
state2int必填状态1已入住
2待下发退房
3待下发入住
4挂失
5待下发挂失
6待下发续住
sendStatus2int必填状态1成功
2下发失败
3下发中
password2String可选密码authType=2 表示为密码 AES加密
authType=4表示为卡片
useNum2int可选使用次数255或空表示无限次
限制次数,最大是254次

异常码

异常码异常描述
500001参数异常
500204门锁不支持该功能
500209未绑定发卡器
500300房间不存在
500403未读取到卡片信息
500503重复授权
500504不支持该功能
500508PMS入住不允许直接退房,请前往PMS页面操作