1、酒店通信系统 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
2、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/I
3、P 完成本协议规范的通信。二 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 秒内收到任何应答表示消息发送
4、失败。其中 ACK 是一个字节值是0x06，NACK 是一个字节值是 0x07.2.4 TCP/IP 链路存活消息这个消息是通信双方每隔 30 秒向对方发送的消息。假如 PABX 在 60 秒内收到 PMS 发送过来的链路存活消息则关闭连接并清空链路的缓冲区。字段 STX # Node Identification ETX长度 1 1 4 1- “#”表示是 TCP/IP 链路存活消息- Node id:- “FFFF”表示是 PMS 发送给 PABX 的链路存活消息.- “EEEE” 表示是 PABX 发送给 PMS 的链路存活消息.2.5 字段填充如果请求消息中的字段的值长度少于协议中规定
5、的长度则用空格字符填充到协议中规定的字符长度。3. PABX 到 PMS 之间的消息3.1 CDR（话单）发送请求消息当 PMS 没有告诉 PABX 酒店没有处于夜审状态时，PABX 在呼叫结束时，会主动发送CDR 给 PMS，话单以文本格式进行传输。注：各个不同字段的长度以字节为单位。字段 STX J ROOM Call type Start timeduration costNumber called or calling numberETX长度 1 1 8 1 14 5 8 20 1- “J”字符 : CDR（话单）发送请求消息- ROOM(8 个字符): 客房号- Call Type(
6、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 检测到用
7、户的语音邮箱的状态，并把相应的状态发送给PMS。注：各个不同字段的长度以字节为单位。字段 STX E ROOM Code M Status ETX长度 1 1 8 1 1 1- “E”字符: 表示事情消息- ROOM(8 个字符): 客房号- “M”字符: 表示语音邮箱事件。- Status(1 个字符)：-“0”,表示语音邮箱已空-“1-8”,表示剩余的语音留言数，9 表示语音数溢出。3.3 房间状态事件该事件是把相应的的房间状态发送给 PMS。注：各个不同字段的长度以字节为单位。字段 STX E ROOM Code S Status Account ETX长度 1 1 8 1 1 10 1
8、- “E”字符: 表示事情消息- ROOM(8 个字符): 客房号- “S”字符: 房间状态事件。- Status(1 个字符)：- 1: 未打扫- 2: 已打扫- 3: 正在查房- Account(10 个字符): 帐号3.4 Minibar 入账事件该事件是把相应的的房间 Minibar 消费总额费用发送给 PMS。注：各个不同字段的长度以字节为单位。字段 STX E ROOM Code C Charge Account ETX长度 1 1 8 1 8 10 1- “E”字符: 表示事情消息- ROOM(8 个字符): 客房号- “C”字符: Minibar 入账事件。- Charge(8
9、 个字符): 消费总额，格式是 7 个数字字符加一个小数点，如 7.02 表示 7元 2 分- Account(10 个字符): 帐号3.5 Minibar 清单事件该事件是把相应的的房间消费清单发送给 PMS。注：各个不同字段的长度以字节为单位。字段 STX E ROOM Code I Detail Quantity AccountETX长度 1 1 8 1 30 3 10 1- “E”字符: 表示事情消息- ROOM(8 个字符): 客房号- “I”字符: Minibar 清单事件,1 个字符。- Detail：物品清单编号，30 个字符。- Quantity：物品数量， 3 个字符。-
10、Account(10 个字符): 帐号3.6 REPLY 消息当 PABX 收到 PMS 发送过来的命令消息时，发送该消息表示 PABX 是否接受或拒绝发送过来的命令消息。注：各个不同字段的长度以字节为单位。字段 STX R ROOM Status ETX长度 1 1 8 1 1- “R”字符:表示 REPLY(回应 )消息- ROOM(8 个字符): 客房号。- Status(1 个字符)：表示各个具体 PMS 命令的响应.E: 错误的消息G: 不可用的客房号。I : 回应 PMS 发送过来的 CHECK-IN 消息。J： 拒绝 PMS 发送过来的 CHECK-IN 消息。O： 回应 PMS
11、 发送过来的 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 消息
12、。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 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STXA ROOM Name LanguageVIP statu
13、sDOD Wake-up call time长度 1 1 8 20 1 1 3 4字段 DND ETX长度 1 1- “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 个字符)：呼叫权限
14、。第一个字符表示市话，第二个字符国内长途，第三个字符表示国际长途。 ”0”:表示未开通， ”1”:表示开通。- Wake-up call time(4 个字符 )：叫醒时间。- 0000 :表示没有该功能-HHMM 表示呼叫叫醒时间， 24 小时制的。-DND(1 个字符): 免打扰“1”：开启。“0”：关闭。4.2 ROOM CHANGE 换房消息当客人的所登记的客房发生改变，PMS 发送该消息给 PABX。PABX 收到该消息后，关闭原先客房的外呼权限，并转移用户的呼叫属性和配置信息。PABX 返回REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX H O
15、ld room New room ETX长度(以字节为单位)1 1 8 8 1- “H” 字符: 表示 ROOM CHANGE 消息- Old room(8 个字符): 旧客房- New room(8 个字符) :新客房4.3 VOICE MAIL ATTRIBUTION 语音邮箱属性消息该消息是用于开启或关闭客房的语音邮箱功能。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX F room Action ETX长度(以字节为单位)1 1 8 1 1- “F” 字符:表示 ROOM CHANGE 消息- room(8 个字符): 客房编号-
16、Action(1 个字符)属性- 1: 开启- 0 :关闭4.4 Modification 修改客房信息PMS 可以通过该消息修改，客房用户的信息如修改呼叫权限、修改叫醒服务时间、开启或关闭免打扰信息等信息。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STXM ROOM Name LanguageVIP status DOD Wake-up call time长度 1 1 8 20 1 1 3 4字段 DND ETX长度 1 1- “M”字符: Modification 修改客房消息- ROOM(8 个字符): 客房号- Name(20 个字符
17、): 客户姓名，以“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” :表示没有该功能-
18、“HHMM”表示呼叫叫醒时间，24 小时制的。-DND(1 个字符): 免打扰1：开启。0：关闭。4.5 CHECK-OUT 退房消息当用户退房时，PMS 应该发送该消息给 PABX，通知 PABX 用户已退房。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX D room ETX长度(以字节为单位)1 1 8 1- “D” 字符:, 表示是退房消息。- room(8 个字符):表示退房的客房号。4.6 Night Audit Request(夜间审计请求消息)当酒店开始夜间审查时，PMS 发送该消息给 PABX 告诉酒店开始夜审。PABX
19、收到该消息后停止或重新开始向 PMS 发送话单。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX N Code ETX长度 1 1 1 1- “N”字符:, 夜间审计请求消息。- Code(1 个字符):表示夜审的操作码。- “0”表示结束夜审。- “1”表示开始夜审。4.7 Call barred Telephone(禁拨号码)设置通过 PMS 可以设置酒店禁止外拨号码。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX B Number called ETX长度 1 1 20 1- “B”字符:, 禁拨号码设置请求消息。- Number called (20 个字符): 被叫号码，格式与 ISDN 号码格式一致。4.8 添加语音留言通过 PMS 可以为客房用户的座机手工添加新留言的功能。PABX 返回 REPLY 消息回应消息处理的结果。注：各个不同字段的长度以字节为单位。字段 STX V ROOM ETX长度 1 1 8 1- “V”字符 :, 语音留言设置。ROOM(8 个字符): 客房号。
