酒店接口协议[中文].doc

酒店接口通信协议
文件编号：
版本：V2.3

单　　位：珠海市佳和电子有限公司
发行日期：2005-12-06
总页数（含本页）：
制定部门：研发部
制　　定：张剑华 签字：_______________
审　　核： 签字：_______________

发行编号：_______________

1. 概述
1.1 目的
制定与酒店管理软件的通信协议。
1.2 适用范围
NTX开发人员、酒店管理软件开发人员。
1.3 修改记录
责任人
时间
描述
版本
张剑华
2009-03－17
新建
V2.0

协议详细定义
1.4 说明
1. 酒店管理软件采用TCP方式与佳和NTX系统通信，NTX系统作为TCP服务器端，侦听30224端口。
2. 协议内容为纯ASCII码。
3. 每一帧数据都以 \r\n(回车换行)结束。
4. NTX系统每收到一个请求，在处理完成后，均会发送ACK帧作为应答。
5. 协议内容以字符‘|’分隔不同的字段，字段出现的位置不确定。
6. 每个字段的结构为：字段名＋内容。

1.5 命令码（字段名为RCT）定义
命令码
描述
01
签入 (HotelManager à PBX)
02
签出 (HotelManager à PBX)
04
换房 (HotelManager à PBX)
10
免打扰 (HotelManager à PBX)
11
服务等级 (HotelManager à PBX)
19
叫醒 (HotelManager à PBX)
22
话单 (PBX à HotelManager)
23
心跳 (HotelManager à PBX)
24
话机绑定 (HotelManager à PBX)

1.6 字段定义
字段名
描述
DAT
日期 (dd/mm/yyyy)
DND
免打扰 ( Y or N 表示 启用/禁用)
DUR
呼叫时长，秒为单位
EXT
分机号码
MWL
留言灯 ( Y or N) Y=点亮, N=关闭
NAM
客户名称
OEX
旧的分机号
SDT
通话起始日期 (dd/mm/yyyy)
SEQ
协议序号 0-9999
STI
通话起始时间 (hh:mm:ss)
TEL
拨打的号码
TIM
时间 (hh:mm:ss)
TRK
中继号
WUD
叫醒日期 (dd/mm/yyyy)
WUS
叫醒状态：
WR = 请求
WA = 应答
WC = 清除
WB = 忙
WN = 无应答
WUT
叫醒时间 (hh:mm:ss)

字段名
描述
AUT
认证码
LNG
客户使用的语言
REM
备注
SDR
发送方ID
SDA
通话起始日期 (dd/mm/yyyy)
VIP
VIP用户
BND
需要绑定的分机号、为空表示取消绑定
BTP
绑定类型 ( 0 or 1) / 0表示同时振铃/1表示顺序振铃

举例
签入 (HotelManager à PBX)
|RCT01|EXT3000|SEQ2428|COS5 |NAMZhangShuaiJun|DAT23/11/2004|TIM00:00:21|

签出 (HotelManager à PBX)
|RCT02|EXT3000|SEQ1234|COS0|DAT23/11/2004|TIM04:52:35|

换房 (HotelManager à PBX)
|RCT04|EXT3000|SEQ107|OEX2000|DAT13/12/2004|TIM15:22:10|

话单 (PBX à HotelManager)
|RCT22|EXT3000|SEQ14|SDT14-05-2004|STI17:54:00|DUR121|TEL[phone]|TRK34|

换房 (HotelManager à PBX)
|RCT11|EXT3000|SEQ9981|COS5| DAT24/11/2004|TIM06:02:02|

免打扰设置 (HotelManager à PBX)
|RCT10|EXT3000|SEQ9980|DNDY|DAT24/11/2004|TIM06:02:02|

叫醒设置 (HotelManager à PBX)
|RCT19|EXT3000|SEQ1181|WUD24/11/2004|WUT06:00:00|WUSWR|DAT23/11/2004|TIM00:08:12|

叫醒状态返回 (PBX à HotelManager)
|RCT19|EXT3000|SEQ1201|WUD24/11/2004|WUT06:00:00|WUSWA|

绑定分机 (HotelManager à PBX)
|RCT24|EXT3000|SEQ9980|BND13836172238|BTP0|DAT24/11/2004|TIM06:02:02|
1.7 应答与保活
每一来自酒店管理系统的请求侦，佳和PBX都有一个ACK侦作为应答：
|ACK0|SEQ1181|
其中应答码值为0表示操作成功，其他值表示出错代码。1181表示原请求侦的SEQ请求序列号。

酒店管理系统需要每隔10秒钟向PBX发送如下请求，以作保活：
|RCT23|
对于该请求，佳和PBX不会做任何应答。