3CX PMS协议规范
介绍
本章详细介绍了与PMS酒店软件集成的3CX PMS协议。 3CX PMS协议非常类似于Mitel PMS协议,因此可以在PMS系统中指定Mitel PMS协议。该协议在本章进一步详细介绍。
通用协议信息
PMS /系统双向(通过半双工)链路使用ENQ / ACK / STX-text-ETX / ACK协议。 PMS到系统传输顺序为:
消息传输完成。
传输序列有时序限制:
STX + msg + ETX传输后等待ACK的最长时间为3秒。
PMS到系统传输
从PMS收到ENQ字符后,系统会在ACK或NAK三秒钟内响应。 ACK表示传输成功。 NAK表示发生传输错误,或系统正忙。系统会生成一个酒店日志,指示发生此类错误。发送ACK后,系统立即准备好接收到STX,消息文本和ETX。在接收到ETX的三秒钟内,它会响应:
- 指示发送的ACK成功,所有消息字段都有效。
- NAK表示在传输本身,消息字段之一或消息的语法(特别是STX,ETX,功能码和状态码)中有错误,例如,CHK3被发送而不是CHK1)。系统生成一个酒店日志,指示发生此错误。 PMS能够重试三次发送消息txn(STX,消息文本和ETX),而不用首先使用ENQ消息进行预发送。
以下示例说明了PMS事务重试:
PMS然后丢弃该事务。
PMS格式规范
消息具有以下一般格式:
入住/退房邮件
该消息具有以下格式:
X:是进/出状态码
- 用于签入的ASCII字符1
- ASCII字符0表示退出
SP:ASCII空白字符。 n是分机号码。
注意:小于五位数的分机号码填充有空格(ASCII 32,HEX 20),而不是零(ASCII 48,HEX 30)。
如果从PMS接收到的消息无效,则系统返回一个NAK(用于否定应答的ASCII字符)。
例:
入住日期:(签入延期100)
STXCHK1 100ETX(其中STX = 2,ETX = 3)导致以下消息2CHK1 1003
姓名留言
该消息是从PMS发送的,用于在电话上显示来宾姓名。名称消息具有以下输入格式:
NAM:是名称功能代码。
NAME:是一个名字(最多21个字符)的字符。
n:是分机号码。
名称的长度(最多21个字符)是左对齐的,空格用于填充。字符可以是大写或小写,也可以包括数字字符。可以给出名字和姓氏(以逗号分隔,但位于第1位和第21位),但如果只出现一个名称,则默认记录为姓氏。字符串中的名字必须是姓氏或姓氏,后跟名字。如果只给出一个名字,则第21个字符为空(名称的最大大小为20)。
使用字符串操作代码允许添加和删除与扩展名相关的特定名称。
该系统允许根据车站添加多个名称。大多数情况下通常只有一个与电台号码相关的名称。
字符串操作代码是状态代码的第一个字节,可能是以下选项之一:
- (添加) – 该名称被添加到当前的本站列表中。如果没有此号码的名称,则会创建一个新的电话簿条目。
- (替换) – 该名称用于根据此号码替换第一个字母名称。所有其他与此号码相对应的名称不会更改
如果从PMS接收到无效的消息,系统返回一个NAK。
唤醒消息
PMS系统可以通知系统何时设置特定客座的唤醒呼叫。唤醒消息具有以下输出格式:
t:叫醒时间
n:是分机号码。
唤醒时间在24小时内指定。所有四个字符,填充ASCII空格,表示删除唤醒时间(时间格式:HHmm)。
唤醒时间为23时30分,延长100分钟为例:
2MW 2330 1003
DND消息
PMS系统可以通过发送以下消息来通知PBX何时设置特定客座的DND状态。
DND消息具有以下格式:
状态码:
- 1 – DND ON
- 0 – DND OFF
- SP是ASCII空白字符。
- 示例:为扩展302设置DND ON
- 2DND1 3023 STXDND1SPSPSP302ETX
- StxValue = 2
- EtxValue = 3
- ENQ = 5;
- ACK = 6;
- NACK = 21
消息注册消息
每次酒店分机进行中继线呼叫时,系统会向PMS发送消息,以更新对客房进行的外部呼叫的总计数。本地和长途电话没有区别。消息注册通过计算在呼叫期间进行的电表脉冲数来进行工作。
消息注册消息具有以下输出格式:
SP:ASCII空白字符。
n:是分机号码。
这种情况下的状态码是费用或挂号。这是状态代码长度的一个例外,是4个字节而不是2个字节。
留言等待讯息
此消息的格式对于两个方向是相同的。消息的格式类似于使用二进制状态代码提供消息等待指示灯的新状态的检入/关闭消息。
留言等待消息具有以下格式:
SP:ASCII空白字符。
讯息等待灯状态码。
- 用于灯亮的ASCII字符1
- Lamp Off的ASCII字符0是分机号码。
站限制消息
站限制消息可用于建立呼叫限制。当这个消息从PMS发送到系统时,它使先前编程的呼叫限制生效。
注意:紧急服务(911/999)和内部通话不受限制。
“站限制”消息具有以下格式:
RST:站限制功能代码。
X:是分机号码或号码号码。
S:是以下状态码之一:
0 – 内部
1 – 本地
2 – 长途
StxValue = 2
EtxValue = 3
ENQ = 5;
ACK = 6;
NACK = 21
女佣状态消息
女佣状态消息用于允许清洁者通过电话设置房间的状态。女佣状态消息由来自有问题的房间的呼叫触发,并通过输入特殊功能码,然后是适当的代码来指定房间的状态。
例如,从房间拨打“* 682”将会向PMS发出女佣状态消息,该消息将会将房间的状态设置为清洁。
女佣状态消息具有以下格式:
STX
小号
Ť
小号
X
SP
ñ
ñ
ñ
ñ
ñ
ETX
X:是女佣状态码。
SP:ASCII空白字符。
n:站号是数字(最多5位数)。
当拨打功能代码时,系统会向PMS发送功能和状态代码,PMS以以下方式解释代码:
消息占用条件
- STS1 – 女佣礼物
- STS2 – 清洁
- STS3 – 不干净
- STS4 – 停止服务
- STS5 – 待检
- STS6 – 被占用/清洁
- STS7 – 被占用/不清洁
- STS8 – 空置/清洁
- STS9 – 空置/不清洁
迷你酒吧消息
迷你吧信息允许迷你酒吧人员通过电话将迷你酒吧使用转移到PMS系统。迷你酒吧消息是通过来自所讨论的房间的呼叫触发的,并通过输入特殊功能代码,然后是适当的项目代码和金额。例如* 68 * 10 * 2,将发送给PMS,房间有2个单位的项目代码10。
如果代码正确,将播放成功消息。如果不正确,将会播放错误信息。这些消息可以从接口配置。可以从3CX酒店管理控制台配置正确的迷你酒吧项目代码。
迷你邮件消息具有以下格式:
STX
中号
ñ
乙
SP
c c c c(30)
n n n n n
ETX
nnnnn:分机号码
cccccc:数据长度30位,可以填0-9,*
*:角色有两个角色:分隔符和乘法
示例:分机100的迷你吧请求:
这意味着总共发送代码项20(可乐),总共1个,项目代码50(巧克力)共3个。