酒店管理系统PMS接口协议.doc

.酒店通信系统PMS接口协议规范一 简介1二 TCP/IP链路22.1 TCP层22.2 请求包的格式规范22.3 TCP/IP链路通信确认机制22.4 TCP/IP链路存活消息22.5 字段填充23. PABX到PMS之间的消息33.1 CDR（话单）发送请求消息33.2 语音邮箱事件33.3 房间状态事件33.4 Minibar入账事件43.5 Minibar清单事件43.6 REPLY消息54. PMS到PABX之间的消息54.1 CHECK-IN消息54.2 ROOM CHANGE 换房消息64.3 VOICE MAIL ATTRIBUTION语音邮箱属性消息64.4 Modification修改客房信息74.5 CHECK-OUT 退房消息74.6 Night Audit Request(夜间审计请求消息)84.7 Call barred Telephone(禁拨号码)设置84.8添加语音留言8修订历史8一 简介 本协议规范的目的是使酒店通信系统(以下简称PABX)能够同步与酒店管理系统(以下简称PMS)完成酒店用户的Check-In、Check-Out和换房，并能够主动向酒店管理系统发送用户发起呼叫所产生的计费帐单。 PABX与PMS之间采用TCP/IP完成本协议规范的通信。二 TCP/IP链路 2.1 TCP层 采用IPV4，PABX是TCP链路连接的服务端，PMS是TCP链路连接的客户端，TCP通信端口是5001. 2.2 请求包的格式规范 除了ACK、NACK以外的每个请求都已STX(0x02)开始，ETX(0x03)结束，STX和ETX之间为请求消息内容，即,MSGBODY内必须不能包含STX或ETX字符。 2.3 TCP/IP链路通信确认机制 当收到请求消息后，接收方必须在15秒内回复发送方ACK或NAK消息。如果发送方收到NACK消息或未在15秒内收到任何应答表示消息发送失败。其中ACK是一个字节值是0x06，NACK是一个字节值是0x07.2.4 TCP/IP链路存活消息 这个消息是通信双方每隔30秒向对方发送的消息。假如PABX在60秒内收到PMS发送过来的链路存活消息则关闭连接并清空链路的缓冲区。字段STX#Node IdentificationETX长度1141- “#”表示是TCP/IP链路存活消息- Node id:- “FFFF”表示是PMS发送给PABX的链路存活消息.- “EEEE” 表示是PABX发送给PMS的链路存活消息. 2.5 字段填充 如果请求消息中的字段的值长度少于协议中规定的长度则用空格字符填充到协议中规定的字符长度。 3. PABX到PMS之间的消息3.1 CDR（话单）发送请求消息 当PMS没有告诉PABX酒店没有处于夜审状态时，PABX在呼叫结束时，会主动发送CDR给PMS，话单以文本格式进行传输。 注：各个不同字段的长度以字节为单位。字段STXJROOMCall typeStart timedurationcostNumber called or calling numberETX长度11811458201- “J”字符: CDR（话单）发送请求消息- ROOM(8个字符):客房号- Call Type(1个字符):呼叫类型，”a”,主叫，”b”，被叫。- Starttime(14个字符):呼叫开始时间，格式如yyyymmddhhmmss,如”20080808202020”- Duration(5个字符):呼叫周期，格式为mmmss,如01520表示的是15分钟20秒。- Cost(8个字符):话费，格式是7个数字字符加一个小数点，如7.02表示7元2分。- Number called or calling number(20个字符)：主叫或被叫号码，格式与ISDN号码格式一致。3.2 语音邮箱事件 该事件在用户退房时，PABX检测到用户的语音邮箱的状态，并把相应的状态发送给PMS。注：各个不同字段的长度以字节为单位。字段STXEROOMCode MStatusETX长度118111- “E”字符:表示事情消息- ROOM(8个字符):客房号- “M”字符: 表示语音邮箱事件。- Status(1个字符)：-“0”,表示语音邮箱已空-“1-8”,表示剩余的语音留言数，9表示语音数溢出。3.3 房间状态事件 该事件是把相应的的房间状态发送给PMS。注：各个不同字段的长度以字节为单位。字段STXEROOMCode SStatusAccountETX长度11811101- “E”字符:表示事情消息- ROOM(8个字符):客房号- “S”字符: 房间状态事件。- Status(1个字符)：- 1: 未打扫- 2: 已打扫- 3: 正在查房- Account(10个字符):帐号3.4 Minibar入账事件 该事件是把相应的的房间Minibar消费总额费用发送给PMS。注：各个不同字段的长度以字节为单位。字段STXEROOMCode CChargeAccountETX长度11818101- “E”字符:表示事情消息- ROOM(8个字符):客房号- “C”字符: Minibar入账事件。- Charge(8个字符): 消费总额，格式是7个数字字符加一个小数点，如7.02表示7元2分- Account(10个字符):帐号3.5 Minibar清单事件该事件是把相应的的房间消费清单发送给PMS。注：各个不同字段的长度以字节为单位。字段STXEROOMCode IDetailQuantityAccountETX长度1181303101- “E”字符:表示事情消息- ROOM(8个字符):客房号- “I”字符: Minibar清单事件,1个字符。- Detail：物品清单编号，30个字符。- Quantity：物品数量，3个字符。- Account(10个字符):帐号3.6 REPLY消息 当PABX收到PMS发送过来的命令消息时，发送该消息表示PABX是否接受或拒绝发送过来的命令消息。注：各个不同字段的长度以字节为单位。字段STXRROOMStatusETX长度11811- “R”字符:表示REPLY(回应)消息- ROOM(8个字符):客房号。- Status(1个字符)：表示各个具体PMS命令的响应. E: 错误的消息 G: 不可用的客房号。 I : 回应PMS发送过来的CHECK-IN消息。 J： 拒绝PMS发送过来的CHECK-IN消息。 O： 回应PMS发送过来的CHECK-OUT消息。 P: 拒绝PMS发送过来的CHECK-OUT消息。 C： 回应PMS发送过来的ROOM CHANGE消息。 D: 拒绝PMS发送过来的ROOM CHANGE消息。 M： 回应PMS发送过来的Modification消息。 N: 拒绝PMS发送过来的Modification消息。 V: 回应PMS发送过来的语音邮箱属性消息。 W: 拒绝PMS发送过来的语音邮箱属性消息。 U: 回应PMS发送过来的Night Audit Request消息。 T: 拒绝PMS发送过来的Night Audit Request消息。 X: 回应PMS发送过来的Call barred Telephone消息。 Z: 拒绝PMS发送过来的Call barred Telephone消息。A: 回应PMS发送过来的语音留言设置消息。 B: 拒绝PMS发送过来的语音留言设置消息。4. PMS到PABX之间的消息4.1 CHECK-IN消息 当有新的客户入住时，PMS登记完用户的信息后把用户的信息发送给PABX。 注：各个不同字段的长度以字节为单位。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXAROOMNameLanguageVIP statusDODWake-up call time长度118201134字段DNDETX长度11 - “A”字符:表示 CHECK-IN消息- ROOM(8个字符):客房号- Name(20个字符): 客户姓名，以“utf-8“编码。- Language(1个字符)：客户语言，”1”：中文，”2”：英语，”3”：俄罗斯，”4”:日本，”5” :韩国。- Gender(1个字符)：客户性别，“0”：男，“1”：女。- VIP status(1个字符)：“ “（空格），表示不是VIP客户，”V”,:VIP客户- DOD(3个字符)：呼叫权限。第一个字符表示市话，第二个字符国内长途，第三个字符表示国际长途。”0”:表示未开通，”1”:表示开通。- Wake-up call time(4个字符)：叫醒时间。- 0000 :表示没有该功能-HHMM表示呼叫叫醒时间，24小时制的。-DND(1个字符):免打扰 “1”：开启。 “0”：关闭。4.2 ROOM CHANGE 换房消息 当客人的所登记的客房发生改变，PMS发送该消息给PABX。PABX收到该消息后，关闭原先客房的外呼权限，并转移用户的呼叫属性和配置信息。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXHOld roomNew roomETX长度(以字节为单位)11881- “H” 字符:表示ROOM CHANGE消息- Old room(8个字符): 旧客房- New room(8个字符) :新客房4.3 VOICE MAIL ATTRIBUTION语音邮箱属性消息 该消息是用于开启或关闭客房的语音邮箱功能。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXFroomActionETX长度(以字节为单位)11811- “F” 字符:表示ROOM CHANGE消息- room(8个字符): 客房编号- Action(1个字符)属性- 1: 开启- 0 :关闭4.4 Modification修改客房信息 PMS可以通过该消息修改，客房用户的信息如修改呼叫权限、修改叫醒服务时间、开启或关闭免打扰信息等信息。PABX返回REPLY消息回应消息处理的结果。 注：各个不同字段的长度以字节为单位。字段STXMROOMNameLanguageVIP statusDODWake-up call time长度118201134 字段DNDETX长度11 - “M”字符: Modification修改客房消息- ROOM(8个字符):客房号- Name(20个字符): 客户姓名，以“ISO 8859-1“编码。如果是全”0”字符表示未修改- Language(1个字符)：客户语言，”0”：表示未修改，”1”：表示中文，”2”：英语，”3”：俄罗斯，”4”:日本，”5” :韩国。- Gender(1个字符)：客户性别，“0”：男，“1”：女- VIP status(1个字符)：”0”， 表示未修改，”V”,:VIP客户- DOD(3个字符)：呼叫权限。”000”:表示未修改。定义与CHECK-IN中的DOD定义相同。- Wake-up call time(4个字符)：叫醒时间。- “00000” :表示没有该功能-“HHMM”表示呼叫叫醒时间，24小时制的。-DND(1个字符):免打扰 1：开启。 0：关闭。4.5 CHECK-OUT 退房消息 当用户退房时，PMS应该发送该消息给PABX，通知PABX用户已退房。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXD roomETX长度(以字节为单位)1181- “D” 字符:,表示是退房消息。- room(8个字符):表示退房的客房号。4.6 Night Audit Request(夜间审计请求消息) 当酒店开始夜间审查时，PMS发送该消息给PABX告诉酒店开始夜审。PABX收到该消息后停止或重新开始向PMS发送话单。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXN CodeETX长度1111- “N”字符:, 夜间审计请求消息。- Code(1个字符):表示夜审的操作码。 - “0”表示结束夜审。 - “1”表示开始夜审。4.7 Call barred Telephone(禁拨号码)设置 通过PMS可以设置酒店禁止外拨号码。PA