安腾酒店宽带计费系统PMS接口协议规范.doc

安腾酒店宽带计费系统PMS接口协议规范安腾网络 2006年02月修订历史2005-7lifei增加夜审支持（最后）注：一般酒店夜审行为对我方透明，夜审缓冲动作由对端电话计费系统或者PMS系统完成。如果我方不是直接连接酒店系统而是由电话计费系统或者专用PMS系统中转，不需要实现夜审功能2005-9-28wzwPR指令的DU改为TU，与程序代码一致2005-10-17digger修改TU说明为可选字段，增加修订历史说明2006-2-14shl增加换房和checkout对用户的在线检查（蓝色字体）一 简介本协议规范的目的是使安腾酒店宽带计费系统（以下简称AMTIUM）能够同步地与酒店管理系统（以下简称HOTEL）完成酒店用户的Check-In、Check-Out和换房，并能够主动向酒店管理系统发送用户上网产生的计费帐单。AMTIUM与HOTEL之间可采用TCP或者串口完成本协议规范的通信。若采用TCP进行通信，AMTIUM作为服务方，监听TCP端口5000。HOTEL作为客户方，HOTEL在同一时刻只能与AMTIUM建立一个TCP连接，HOTEL方主动请求Check-In，Check-Out和换房，AMTIUM主动请求为用户结帐。建议HOTEL方尽可能长时间地保持TCP连接，除非发生故障或者进行系统维护，不要主动关闭TCP连接。若采用串口进行通信，线路规范：默认速率为9600，数据位8，停止位1，无校验位，流控默认为硬件流控，也可视情况采用xon/off或者无流控。本协议描述部分“”间表示必须包含的部分，“”和“”间表示可选可不选的部分。二. 协议描述2.1 请求包格式规范以及应答处理1. 每个请求都以STX（0x02）开始，ETX（0x03）结束，STX和ETX间为请求消息内容，即，MSGBODY内必须不能包含任何STX或ETX字符；2. 若采用串口通信，ETX后可跟一字节的LRC校验，产生LRC的具体算法：从STX后的字节开始，到ETX结束（不包括STX，但是包括ETX）的每字节进行XOR操作，结果即为LRC，此时请求包格式为LRC；3. 任意方接受到请求后，必须回答ACK（0x06）、或者NAK（0x15）、或者SYN（0x16）。若2秒内无应答则请求方应重发请求，最多可重发三次；4. 只有当请求包内包含有校验字节且当被请求方检查到校验错的情况下，被请求方才能回答NAK；请求方收到NAK时，应重发请求，最大重发次数为3次；5. ACK表示被请求方正确接收到了请求，不表示已经对该请求作了正确的事务处理；6. SYN表示被操作的用户在线，强制此用户下线，并传送帐务，不对该请求做事务处理；7. 请求内容的每个字段间以“|”字符作为分隔字符，每个字段内必须不能包含“|”字符，第一个字段表达该请求的类型，比如是check-in还是check-out，后续的字段包含该类型请求中必要包含的其它信息，比如房间号，客人姓名等。第一个字段前可有分隔符，也可没有分隔符，最后一个字段后可跟分隔符，也可不跟分隔符；请求类型后的各字段间没有特别严格的顺序定义，只要包含了协议规定该请求类型中必须有的所有字段，不论各字段间顺序如何，均视为合法请求；合法请求中不可识别的字段作忽略处理，而不是丢弃整个请求；对于非法请求，做静默丢弃处理。2.2 Check-In流程举例： HOTEL发送：LRCAMTIUM应答：以上表示1108房间张三Check-In，上网帐号为1108，上网密码为1108。字段说明：GI：表示Guest In，用户Check-In请求；RN：表示Room Number，房号，也是上网的帐号；GN：表示Guest Name，用户姓名，该字段可选；PW：表示上网密码，该字段内不能包含空格，建议采用4到6位数字，为方便用户输入，长度最好不超过8位；注：若HOTEL无生成随机密码功能，可以直接将用户帐号、用户姓名等现成的数据作为PW字段送出。2.3 换房流程举例：HOTEL发送：LRCAMTIUM 检查“RO”用户是否在线，然后做如下处理：若RO用户不在线，AMTIUM应答： 若RO用户在线，AMTIUM应答：以上表示1107房的用户换房到1108。GC：表示Guest Change，用户换房请求；RN：表示Room Number，用户要换到的新房间号；RO：表示Room Old，用户原来所在的旧房间号；：表示用户在线，做强制用户下线动作，不做换房动作， HOTEL需要在N秒（建议5秒，推荐为N可配置）后重发LRC；：表示用户不在线。注：用户换房后，上网帐号变为新的房间号，但是上网密码不改变。2.4 Check-Out流程举例：HOTEL发送：LRCAMTIUM 检查“RN”用户是否在线，然后做如下处理：若RN用户不在线，AMTIUM应答： 若RN用户在线，AMTIUM应答：以上表示1108房间的用户Check-Out。GO：表示Guest Out，用户Check-Out请求；RN：表示Room Number，用户房间号；：表示用户在线，做强制用户下线动作，不做Check-Out动作，HOTEL需要在N秒（建议5秒，推荐为N可配置）后重发LRC；：表示用户不在线。2.5 帐单请求流程举例：AMTIUM发送：LRCHOTEL应答：LRCAMTIUM确认：以上表示1108房用户，于2003年1月1日21:10:30产生了12.00元的上网费用，上网时长为302秒。PR：表示Posting Request，帐单请求；RN：表示Room Number，房间号；TA：表示Total Amount，本帐单计费金额，单位为元，可跟两位小数；DA：表示DATE，帐单产生日期，YYMMDD格式；TI：表示TIME，帐单产生时间，HHMMSS格式；TU：表示Time Usage，上网时长，单位为秒（该字段可选）；P#：表示本帐单流水号，必须为数字；PA：表示Posting Answer，帐单应答；AS：表示Answer Status，应答状态，若帐单请求处理成功，后必须跟OK，否则跟其它字符串，说明失败原因；注：一个帐单请求事务中通信双方的P#字段内容必须匹配。AMTIUM为每个帐单生成唯一的流水号，当需要重发帐单时，帐单请求的每一部分，包括P#，DA和TI字段都必须保持不变。帐单的最大重发次数为3次，等待应答的超时参数为2秒。2.6 夜审流程酒店管理系统可能需要在凌晨的时候做夜审。在夜审期间，如果酒店管理系统不可以接受和缓存AMTIUM发送过去的帐单，可以发送夜审信号通知AMTIUM，由AMTIUM来缓存帐单，等夜审结束的时候再把夜审期间缓存的帐单发送给酒店管理系统。如果AMTIUM在夜审结束信号之前收到酒店管理系统发过来的CheckIn、CheckOut或ChargeRoom信号，会认为夜审已经结束，开始正常抛帐。2.6.1 夜审开始：举例：HOTEL发送：LRCAMTIUM应答：以上表示酒店管理系统在2006年6月7日01:01:00通知AMTIUM：HOTEL夜审开始NS：表示Night Audit Start，夜审开始；DA：表示DATE，夜审开始日期，YYMMDD格式；TI：表示TIME，夜审开始时间，HHMMSS格式；2.6.