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

1、酒店通信系统PMS接口协议规范一简介二 TCP/IP 链路1.1 TCP 层1.2 请求包的格式规范 1.3 TCP/IP链路通信确认机制 1.4 TCP/IP链路存活消息 1.5 字段填充3. PABX到PMS之间的消息3.1 CDR （话单）发送请求消息 3.2 语音邮箱事件3.3 房间状态事件 3.4 Minibar入账事件 3.5 Minibar 清单事件 3.6 REPLY 消息4. PMS到PABX之间的消息4.1 CHECK-IN 消息 4.2 ROOM CHANGE 换房消息4.3 VOICE MAIL ATTRIBUTION语音邮箱属性消息 4.4 Modification

2、修改客房信息 退房消息 4.5 CHECK-OUT4.6 Night Audit Request（夜间审计请求消息）4.7 Call barred Telephone（禁拨号码）设置4.8 添加语音留言修订历史一简介本协议规范的目的是使酒店通信系统（以下简称PABX）能够同步与酒店 管理系统（以下简称PMS）完成酒店用户的Check-InCheck-Out和换房， 并能够主动向酒店管理系统发送用户发起呼叫所产生的计费帐单。PABX与PMS之间采用TCP/IP完成本协议规范的通信。二 TCP/IP 链路2.1 TCP 层采用IPV4, PABX是TCP链路连接的服务端，PMS是TCP链路连接的

3、客户端，TCP通信端口是5001.2.2 请求包的格式规范除了 ACK、NACK以外的每个请求都已STX（0x02）开始，ETX（0x03） 结束，STX和ETX之间为请求消息内容，B|J, MSGBODY 内必须不能包含STX字符。ETX或.2.3 TCP/IP链路通信确认机制当收到请求消息后，接收方必须在15秒内回复发送方ACK或NAK消 息。如果发送方收到NACK消息或未在15秒内收到任何应答表示消息发送 失败。其中ACK是一个字节值是0x06, NACK是一个字节值是0x07.2.4 TCP/IP链路存活消息这个消息是通信双方每隔30秒向对方发送的消息。假如PABX在60 秒内收到PM

4、S发送过来的链路存活消息则关闭连接并清空链路的缓冲区。*字段STX升NodeETXIdentification1 411长度-表示是TCP/IP链路存活消息- Node id:- “FFFF”表示是PMS发送给PABX的链路存活消息.- “EEEE”表示是PABX发送给PMS的链路存活消息.2.5字段填充如果请求消息中的字段的值长度少于协议中规定的长度则用空格 字符填充到协议中规定的字符长度。.3. PABX到PMS之间的消息3.1 CDR （话单）发送请求消息当PMS没有告诉PABX酒店没有处于夜审状态时，PABX在呼叫结束 时，会主动发送CDR给PMS,话单以文本格式进行传输。注：各个不同

5、字段的长度以字节为单位。.字 STJ ROOM Call StarduratcoNumber ETX st called type or t 段 ion X calling time number 长度 1 1 8 1 14 5 8 20 1-J”字符：CDR （话单）发送请求消息 -ROOM（8个字符）：客房号-Call Type（l个字符）：呼叫类型， a“，主叫，“ b，被叫。-Starttime（14个字符）：呼叫开始时间，格式如yyyymmddhhmmss,如“- Duration（5个字符）:呼叫周期,格式为mmmss,如01520表示的是15分 钟20秒。- Cost（8个字符）

6、话费，格式是7个数字字符加一个小数点，如7. 02表示 7元2分。- Number called or calling number （20个字符）：主叫或被叫号码，格式 与号码格式一致。ISDN.3.2 语音邮箱事件该事件在用户退房时，PABX检测到用户的语音邮箱的状态，并把相应的状态发送给PMS。注：各个不同字段的长度以字节为单位。字段STX长度1E 1ROOM 8Code M Status 1 1ETX1- E”字符:表示事情消息- ROOM（8个字符）：客房号- M”字符：表示语音邮箱事件。- Status （1 个字符）:- “0”，表示语音邮箱已空- “8”，表示剩余的语音留言数

7、9表示语音数溢出。3.3 房间状态事件该事件是把相应的的房间状态发送给PMSo注：各个不同字段的长度以字节为单位。字段STXEROOMCode S StatusAccounETXt1 1101181长度- E”字符:表示事情消息- ROOM（8个字符）：客房号房间状态事件。：”字符S- Status （1 个字符）：- 1：未打扫- 2:己打扫- 3:正在查房- Account （10个字符）:帐号3.4 Minibar入账事件该事件是把相应的的房间Minibar消费总额费用发送给PMSo注：各个不同字段的长度以字节为单位。字STE 1ROOM 8CodeChargeAccounETX段X

8、1C 18t长1 10度- E”字符:表示事情消息- ROOM（8个字符）：客房号- C字符：Minibar入账事件。- Charge（8个字符）:消费总额，格式是7个数字字符加一个小数点,如7. 02表示7元2分-Account （10个字符）:帐号3.5 Minibar清单事件该事件是把相应的的房间消费清单发送给PMSo注：各个不同字段的长度以字节为单位。.字字 度字段DNDETX长度11STX ESTAROOMROOMDetCode INameQuantityL anguaAccouVIPDODETXWake-段Xailgent statUP段1 1 8 1 30 3 10 长 1度 c

9、all ustime 长- E”字符:表示事情消息- ROOM（8个字符）：客房号- T 字符：Minibar清单事件，1个字符。- Detail：物品清单编号,30个字符。- 个字符。3Quantity：物品数量,Account （10个字符）：帐号3.6 REPLY 消息当PABX收至IJ PMS发送过来的命令消息时，发送该消息表示PABX是 否接受或拒绝发送过来的命令消息。注：各个不同字段的长度以字节为单位。.字段 STX R ROOM Status ETX181长度11- R”字符:表示REPLY（回应）消息- ROOM（8个字符）：客房号。- Status （1个字符）：表示各个具体

10、PMS命令的响应.E:错误的消息G:不可用的客房号。消息。CHECK-IN发送过来的PMS回应I :J：拒绝PMS发送过来的CHECK-IN消息。0：回应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 Req

11、uest消息。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登记完用户的信息后把用户的信息发送给 PABXo注：各个不同字段的长度以字节为单位。PABX返回REPLY消息回应 消息处理的结果。注：各个不同字段的长度以字节为单位。.118201134- “A

12、字符:表示CHECK-IN消息- ROOM（8个字符）：客房号-Name（20个字符）:客户姓名，以“utf-8 编码。- Language （1个字符）：客户语言，”1个中文，“2：英语,“3”:俄罗。韩 国5” ：斯4”：日本，“-：女。10：男，“Gender。个字符）：客户性别，VIP status （1个 字符）：“ “（空格），表示不是VIP客户， V , : VIP客户- D0D（3个字符）：呼叫权限。第一个字符表示市话，第二个字符国内长途， 第三个字符表示国际长途0” ：表示未开通，“ 1” ：表示开通。- Wake-up call time（4个字符）：叫醒时间。- 000

13、0 :表示没有该功能表示呼叫叫醒时间，24小时制的。- DND（1个字符）：免打扰“1”：开启。”：关闭。0 “4.2 ROOM CHANGE 换房消息、当客人的所登记的客房发生改变，PMS发送该消息给PABX。PABX收到该 消息后，关闭原先客房的外呼权限，并转移用户的呼叫属性和配置信息。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STXHOldroomNew rooETX字m段4113长11 820度长度）节以字（M1R001Name8Langu8VIPDOD1Wake-call为单位STXMagestatusUP- H ”字符:表示ROOM CH

14、ANGE消息- Old room（8个字符）：旧客房- Newroom（8个字符）：新客房4.3 语音邮箱属性消息ATTRIBUTION VOICE MAIL该消息是用于开启或关闭客房的语音邮箱功能。PABX返回REPLY消息回 应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STX Froom Action ETX1长度1181以字节（）为单位-“F”字符：表示ROOM CHANGE消息- room（8个字符）：客房编号属性）个字符Action （1- 1:开启- 0 :关闭4.4 Modification修改客房信息PMS可以通过该消息修改，客房用户的信息如修改呼叫权限、修改叫醒

15、 服务时间、开启或关闭免打扰信息等信息。PABX返回REPLY消息回应消息 处理的结果。注：各个不同字段的长度以字节为单位。.time ETX 字段 DND11长度-M字符：Modification修改客房消息- ROOM（8个字符）：客房号- Name（20个字符）:客户姓名,以“ISO 8859T 编码。如果是全“ 0字 符表示未修改- Language （1个字符）：客户语言，0”：表示未修改，1：表示中文，“2”： 英语，“3”：。韩国5”:日本，俄罗斯,4“ ：- :女10”：男，“Gender。个字符）：客户性别 VIP status （1个字符）： 0”,表示未修改，“ V，：V

16、IP客户D0D中的CHECK-IN定义与表示未修改。：“000”呼叫权限。：）个字符D0D（3定义相同。- Wake-up call time（4个字符）:叫醒时间。- “00000” ：表示没有该功能- 表示呼叫叫醒时间,24小时制的。- DND（1个字符）：免打扰1：开启。0：关闭。4.5 CHECK-OUT退房消息当用户退房时,PMS应该发送该消息给PABX,通知PABX用户已退房。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STX Droom ETX1长度118节字似）为单位-D”字符：，表示是退房消息。-room（8个字符）：表示退房的客房号

17、4.6 Night Audit Request（夜间审计请求消息）当酒店开始夜间审查时，PMS发送该消息给PABX告诉酒店开始夜市。PABX收到该消息后停止或重新开始向PMS发送话单。PABX返回REPLY消 息回应消息处理的结果。1长度1-N”字符:，夜间审计请求消息。-Code。个字符）：表示夜审的操作码。“0”表示结束夜市。 li“1”表示开始夜市。4.7 Call barred Telephone（禁拨号码）设，通过PMS可以设置酒店禁止外拨号码。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段STX B Number ETX called 1 2011 长度-B”字符:，禁拨号码设置请求消息。-Number called （20个字符）：被叫号码,格式与ISDN号码格式一致。4.8添加语音留言通过PMS可以为客房用户的座机手工添加新留言的功能。PABX返回REPLY消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。.ETXROOMVSTX字段.长度1 1 8 1-V”字符:，语音留言设置。客房号。）:个字符R00M（8.