接口说明:
- 下发卡片
- 发卡器读取卡号,调用此接口通过网关将卡号下发到门锁
- 房间封房状态不能下发卡片
1.需要将卡片放入关联的发卡器
2.门锁绑定网关
业务能力:
- openSmartDownSendCardKey
本地服务器版本:
- V1.4.5
Content-Version:
- 1.0
参数:
参数名 | 层级 | 类型 | 条件 | 描述 | 备注 |
---|---|---|---|---|---|
lockCode | 1 | String | 必填 | 门锁号 | 可通过房间列表查看 |
customerName | 1 | String | 必填 | 房客名称 | -- |
copyCheckIn | 1 | int | 必填 | 复制入住 | 本地服务器V1.4.5版本: 0 不复制入住,开始时间取推送过来入住的当前时间,且对房间做退房逻辑 1 复制入住,存在房客入住以房客最早开始时间为准 本地服务器V1.5.0版本: 0 退房后入住 先将对应房源内的所有房客退房(删除授权)再入住(执行当前的新授权),取入参开始时间作为本次入住授权的起始时间(时间精度为小时) 1 立即入住 不删除对应房源内的原有授权,以已入住房客授权的开始时间作为本次入住授权的开始时间,如对应房源内没有已入住的房客,则取当前时间作为本次入住授权的开始时间(时间精度为小时) 2 其他时间入住 不删除对应房源内的原有授权,取入参开始时间作为本次入住授权的起始时间(可以为未来时间,时间精度为小时) 备注: 房间门锁开启顶替功能,如果入住时间触发其他授权顶替,服务器则会有异常提示,第三方需要调整入住时间。 房间开启顶替的情况下,该接口只能选0进行入住。 |
idType | 1 | int | 可选 | 证件类型 | 1身份证 2护照 9其他 |
idNumber | 1 | String | 可选 | 证件号 | 最大支持100个字符 |
beginTime | 1 | long | 必填 | 开始时间 | 时间戳,单位秒 |
endTime | 1 | long | 必填 | 结束时间 | 时间戳,单位秒 |
authorMode | 1 | int | 可选 | 有效期授权方式 | 1:有效期授权 2:周期重复时间段授权 默认为1 |
weeks | 1 | int | 可选 | 星期数 | AuthorMode = 0x02有效 按位域bit0~bit6分别表示,对应bit位数置1,则表示当天钥匙有效 例如:二进制1001011就表示周日,周四,周二,周一 |
dayStartTimes | 1 | String | 可选 | 每日起始时间 | 格式:HH:mm |
dayEndTimes | 1 | String | 可选 | 每日结束时间 | 格式:HH:mm |
useNum | 1 | int | 可选 | 使用次数 | 不填或0表示无限次 限制次数,最大是254次 |
请求示例
{
"tokenId": "aFqJ9GbjlmX0LHZosmciPH3Ewt4S53Fdt/AX7/to/I8IDaYsFkk1cIkz5Ez2Y/PvhDDKWppSuXv1QLcPyLjF+g==",
"method": "openSmartDownSendCardKey",
"data": {
"lockCode": "1.2.201A",
"customerName":"zzy",
"copyCheckIn":0,
"idType":1,
"idNumber":"1231231",
"beginTime":1602165958,
"endTime":1608965958
}
}
响应示例
{
"msgId": 77568002,
"resultCode": 0,
"reason": "",
"method": "openSmartDownSendCardKey",
"data": {
"checkInId": "h0JYf4V93p4=",
"checkInName": "zzy",
"beginTime": 1602165600,
"endTime": 1608965958,
"idType": 1,
"idNumber": "1231231",
"cardNo": "DB730487"
}
}
响应参数说明
参数名 | 层级 | 类型 | 条件 | 描述 | 备注 |
---|---|---|---|---|---|
checkInId | 1 | String | 必填 | 入住ID | -- |
checkInName | 1 | String | 必填 | 用户姓名 | -- |
idType | 1 | int | 可选 | 证件类型 | 1身份证 2护照 9其他 |
idNumber | 1 | String | 可选 | 证件号 | -- |
beginTime | 1 | int | 必填 | 开始时间 | 时间戳:单位秒 |
endTime | 1 | int | 必填 | 结束时间 | 时间戳:单位秒 |
authorMode | 1 | int | 可选 | 有效期授权方式 | 1:有效期授权 2:周期重复时间段授权 默认为1 |
weeks | 1 | int | 可选 | 星期数 | AuthorMode = 0x02有效 按位域bit0~bit6分别表示,对应bit位数置1,则表示当天钥匙有效 例如:二进制1001011就表示周日,周四,周二,周一 |
dayStartTimes | 1 | String | 可选 | 每日起始时间 | 格式:01:00 |
dayEndTimes | 1 | String | 可选 | 每日结束时间 | 格式:02:00 |
useNum | 1 | int | 使用次数 | 每日结束时间 | 不填或255表示无限次 限制次数,最大是254次 |
cardNo | 1 | String | 必填 | 卡号 | -- |
异常码
异常码 | 异常描述 |
---|---|
500001 | 参数异常 |
500204 | 门锁不支持该功能 |
500209 | 未绑定发卡器 |
500300 | 房间不存在 |
500403 | 未读取到卡片信息 |
500503 | 重复授权 |
500504 | 不支持该功能 |
500508 | PMS入住不允许直接退房,请前往PMS页面操作 |