接口说明：

  • 授权手机钥匙
  • 房间封房状态不能授权手机钥匙
需要设置支持APP和小程序授权

业务能力：

  • openSmartAddPhoneKey

本地服务器版本：

  • V1.4.1

Content-Version:

  • 1.0

参数：

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

本地服务器V1.5.0版本:
0 退房后入住
先将对应房源内的所有房客退房（删除授权）再入住（执行当前的新授权），取入参开始时间作为本次入住授权的起始时间（时间精度为小时）
1 立即入住
不删除对应房源内的原有授权，以已入住房客授权的开始时间作为本次入住授权的开始时间，如对应房源内没有已入住的房客，则取当前时间作为本次入住授权的开始时间（时间精度为小时）
2 其他时间入住
不删除对应房源内的原有授权，取入参开始时间作为本次入住授权的起始时间（可以为未来时间，时间精度为小时）
备注：
房间门锁开启顶替功能，如果入住时间触发其他授权顶替，服务器则会有异常提示，第三方需要调整入住时间。
房间开启顶替的情况下，该接口只能选0进行入住。
idType1int可选证件类型1身份证
2护照
9其他
idNumber1String可选证件号最大支持100个字符
beginTime1long必填开始时间时间戳，单位秒
endTime1long必填结束时间时间戳，单位秒
phoneNo1String可选手机号码1.邮箱或手机号码必填其一
2.高级功能设置需要开启APP授权(手机号) 或微信授权(手机号,此参数有效)
email1String可选邮箱1.邮箱或手机号码必填其一
2.高级功能设置需要开启APP授权(邮箱),此参数有效)
3.V2.7.5新增
countryCode1int可选国家编码默认为86
请求示例
{
	"tokenId": "aFqJ9GbjlmX0LHZosmciPH3Ewt4S53Fdt/AX7/to/I8IDaYsFkk1cIkz5Ez2Y/PvhDDKWppSuXv1QcPyLjF+g==",
	"method": "openSmartAddPhoneKey",
	"data": {
		"lockCode": "1.2.201A",
		"customerName":"zzy",
		"copyCheckIn":1,
		"idType":1,
		"idNumber":"1231231",
		"beginTime":1602165958,
		"endTime":1608965958,
		"phoneNo":"13515455351"
	}
}

响应示例

{
	"msgId": 345981978,
	"resultCode": 0,
	"reason": "",
	"method": "openSmartAddPhoneKey",
	"data": {
		"checkInId": "IUMAVJK/7yI=",
		"checkInName": "zzy",
		"beginTime": 1602165600,
		"endTime": 1608965958,
		"idType": 1,
		"idNumber": "1231231",
		"phoneNo": "13535455351",
		"countryCode": 86
	}
}

响应参数说明

参数名层级类型条件描述备注
checkInId1String必填入住ID--
checkInName1String必填用户姓名--
idType1int可选证件类型1身份证
2护照
9其他
idNumber1String可选证件号最大支持100字符
beginTime1long必填开始时间时间戳：单位秒
endTime1long必填结束时间时间戳：单位秒
phoneNo1String必填手机号码--
countryCode1int可选国家编码--

异常码

异常码异常描述
500001参数异常
500104手机号码格式错误
500300房间不存在
500503重复授权
500504不支持该功能
500508PMS入住不允许直接退房，请前往PMS页面操作