大客户酒店接口使用手册.docx
《大客户酒店接口使用手册.docx》由会员分享，可在线阅读，更多相关《大客户酒店接口使用手册.docx（53页珍藏版）》请在冰豆网上搜索。
大客户酒店接口使用手册
技术文件
技术文件名称：
SS10VIC大客户酒店接口使用手册
技术文件编号：
版本：
ZXSS10VICV1.0.2
文件质量等级：
共26页
（包括封面）
拟制
审核
中兴通讯股份有限公司
目录
ZXSS10VIC大客户酒店接口使用手册5
1范围5
2术语、定义和缩略语5
3安装5
3.1命令脚本升级5
3.2配置通信文件5
3.3酒店接口机人机命令配置6
3.4酒店接口机模拟测试8
4酒店接口机命令手册9
4.1计费业务命令9
4.1.1登记、撤销立即计费9
4.1.2启动立即计费话单发送10
4.1.3停止立即计费话单发送10
4.1.4话单的实时传送11
4.1.5话单传送返回11
4.1.6话单重传12
4.1.7输出话单重传数量13
4.1.8握手消息13
4.1.9话单格式14
4.1.10酒店第三方话单接收程序的编写16
4.1.11话单保存成文件方式17
4.2用户管理命令18
4.2.1用户号码18
4.2.2.查询用户权限19
4.2.3.修改用户权限21
4.2.4.查询用户新业务22
4.2.5.预约用户新业务23
4.2.6.删除用户新业务23
4.2.7.查询用户闹醒时间24
4.2.8.创建用户闹醒时间24
4.2.9.修改用户闹醒时间25
4.2.10.删除用户闹醒时间26
4.2.11.显示用户的转移号码27
4.2.12.创建用户的转移号码27
4.2.13.删除用户的转移号码28
4.2.14.激活去激活免打扰业务28
4.2.15用户管理命令使用原则29
4.3大客户更新命令29
4.3.1查询用户信息响应29
4.3.2同步用户信息响应29
4.3.3录音响应30
4.4房态管理命令30
4.4.1向酒店系统鉴权命令30
4.4.2登记房态命令31
5.操作结果码31
5.1软交换操作结果31
5.2HLR操作结果（上移用户）31
6酒店系统的通信部分编程指导37
修改记录
文件编号
版本号
拟制人/
修改人
拟制/修改日期
更改理由
主要更改内容
（写要点即可）
张海军
2006.05.29
创建
杨旭涛
2006-8-15
修改
石启国
2006-8-18
修改
颜虹
2007-06-06
修改
增加第三方酒店和大客户系统的握手说明
注：
文件第一次拟制时，“更改理由”、“主要更改内容”栏写“无”。
ZXSS10VIC大客户酒店接口使用手册
1范围
本手册用于大客户酒店接口机的安装使用，提供对外接口命令格式。
本规范由中兴通讯股份有限公司提出并负责解释。
2术语、定义和缩略语
SS：
SoftSwitch，软交换系统
HLR：
综合智能用户管理平台
MML：
人机命令
3安装
3.1命令脚本升级
酒店接口人机命令提供7952－7955，分别是增加，删除，修改，查询酒店接口配置命令。
3.2配置通信文件
配酒店接口机（可以是大客户服务器或者大客户话务台）zxssopr目录gc_mgt.ini，做如下改动。
NodeStyleCount=7//服务器类型加1，增加了一种新的类型
NodeList2Count=1//增加一个计费服务器，
NodeList5Count=1//增加一个数据代理服务
NodeList6Count=1//增加一个酒店接口机节点
[NodeList2_1]//计费服务器节点信息
NodeCode=306
OfficeCode=1
IP=10.40.94.145
[NodeList5_1]
NodeCode=306//数据库节点号
OfficeCode=1//数据库模块号
IP=10.40.94.145//数据库的IP
[NodeList6_1]
NodeCode=306//酒店接口机的节点号
OfficeCode=1//酒店接口机的模块号
IP=10.40.94.145//酒店接口机的IP
增加一个接口机，都需要更新通信配置。
3.3酒店接口机人机命令配置
使用人机命令7952－7955，通过TELNET连接数据服务器，执行“命令号/？
”如“7952/?
”可以查看帮助。
命令允许输入字符（ASCII0–128）
7952－增加酒店接口
序号
参数名称
可选性
类型
范围
说明
1
HOTELIP
必选
字符
1-20
酒店IP，表示酒店管理机的IP，当参数3群号设为65535，本参数表示端口号，端口请大于1000
2
PORTTYPE
必选
整型
0-255
端口类型，表示端口类型，其中1－对应billcvt.dll，是话单传送的服务；2－对应oamsvr.dll，用户属性管理；3－对应HNormal.dll对应大客户更新；4－对应OprRoomInfo.dll房态管理；现在只支持端口类型1和2
3
CENTREXID
必选
整型
1-65535
群号，表示业务组号，请一定要设置，但是当群号设置为65535时，参数1请设置端口，酒店对应的群号，一个酒店管理一个群
4
DLLNAME
任选
字符
0-16
接口库名，动态库名称，按照参数2端口类型对应动态库名，参见参数2
5
STARTC
任选
字符
0-7
开始符，开始符号，例子中为#，开始和结束符号对应一条酒店管理系统发过来的命令。
6
ENDC
任选
字符
0-7
结束符结束符号，例子中为*
7
IOFFICE
任选
整型
0-255
接口机局号，接口机的局号，和通信支撑规划的局号一样，
8
IMODULE
任选
整型
0-9999
接口机模块号，接口机的模块号，和通信支撑规划的模块号一样
9
IPNO
任选
整型
0-9999
接口机PNO，接口机的PNO号，可不填
10
DOFFICE
任选
整型
0-255
话务台局号，客户端的局号，可不填
11
DMODULE
任选
整型
0-9999
话务台模块号，客户端的模块号，可不填
12
DPNO
任选
整型
0-9999
话务台PNO，客户端进程PNO号，可不填
13
ISHLR
任选
整型
0-1
群是否上移，表示群是否上移到HLR，请注意管理的群是否被上移到HLR上，0－不上移对应SS用户，1－上移对应HLR用户，请确定该群是否上移到HLR.
14
INFO
任选
整型
0-2147483647
备用
配置一台酒店接口机需注意：
一台酒店接口机最多提供10种业务，最多可以连接100个酒店
举例1：
配置一台酒店接口机的计费业务，对酒店管理机提供网络接口。
步骤1：
增加酒店管理机IP-10.40.94.165，业务类型为1，群号为77，动态库名为billcvt.dll，开始符为#，结束符为*，接口机局号为10，模块号为2000，请确认和通信配置文件中一致。
7952:
1="10.40.94.165",2=1,3=77,4=billcvt.dll,5=#,6=*,7=10,8=2000;
步骤2：
增加业务端口，服务端口号5010，业务类型为1，群号为65535时表示输入端口号，接口机局号10，模块号2000。
同一台接口机对应不同业务类型，端口请设置为不同。
7952:
1=5010,2=1,3=65535,7=10,8=2000;
举例2：
配置一台酒店接口机的数据业务，对酒店管理机提供COM1串口（配置都一样，只是与酒店是通过串口线相连）。
步骤1：
增加酒店管理机IP-10.40.94.165，业务类型为1，群号为77，动态库名为oamsvr.dll，开始符为#，结束符为*，接口机局号为10，模块号为2000，请确认和通信配置文件中一致。
7952:
1="10.40.94.165",2=2,3=77,4=oamsvr.dll,5=#,6=*,7=10,8=2000;
步骤2：
增加酒店管理机业务端口5511，业务类型为2，群号为65535时表示输入端口号，接口机局号10，模块号2000。
请确认和通信配置文件中一致。
7952:
1=5511,2=2,3=65535,7=10,8=2000;
注：
1.这里的酒店接口机可以是大客户服务器或者大客户话务台（因为都有Hgatesvr程序和billcvt.dll，oamsvr.dll），注意使用7952命令时局号和模块号设置正确。
2.一个酒店接口机可以对应多个酒店；一个酒店只能对应一个接口机
3．使用酒店接口机的数据业务，确认oamsvr.ini文件设置正确。
串口连接
基本步骤与A中相似，只是步骤1用7952增加的不是IP地址而是”1”（酒店管理机与酒店接口机的com1串口相连）、”2”（酒店管理机与酒店接口机的串口com2相连），串口方式不需要步骤2。
步骤1举例：
7952:
1="1",2=1,3=77,4=billcvt.dll,5=#,6=*,7=10,8=1001;
7952:
1="2",2=2,3=77,4=oamsvr.dll,5=#,6=*,7=10,8=1001;
3.4酒店接口机模拟测试
1．酒店接口机安装好后，打开hgatesvr.exe可以看到以下界面，如图所示，酒店接口机已经打开5010和5011两个端口等待酒店的连接：
2．在对应酒店可以运行版本里Terminal.exe终端仿真程序，在对端IP填入酒店接口机的地址，以及端口号进行连接，如果使用串口，在通信端口中选择相应的端口，如COM1：
对酒店提供网络接口：
如图所示，对端IP指接口机IP，连接成功后输入命令字符串回车
命令字符串如：
#STARTFEEENQAction=REG:
Num=4820001*
成功将返回#STARTFEEENQOK*,表示登记4820001号码的话单传送
接下来输入：
#STARTRESTARTCHARGE*
成功将返回#STARTRESTARTCHARGEACKOK*,表示启动立即话单传送，这时如果有话单，界面上将显示下面格式的话单：
START$CHARGE$Aid$CallingNum$CalledNum$Bearerserv$StartTime$TimeLen&Fee0$fee1$fee2$fee3$fee4$fee5$fee6$fee7$fee8$
4酒店接口机命令手册
4.1计费业务命令
4.1.1登记、撤销立即计费
功能：
酒店系统向大客户系统登记或撤销需要发送话单的号码或群号。
输入：
#STARTFEEENQAction=?
:
Num=?
*
响应：
#STARTFEEACKFAIL:
REASON*或
#STARTFEEACKOK*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
Action的值：
REG/DEL单个号码的登记与注销
CTXREG/CTXDEL群号登记与注销
登记或注销成功则返回#STARTFEEACKOK*。
登记或注销失败则返回#STARTFEEACKFAIL:
REASON*，其中REASON为失败码
REASON=1，表示号码或群号已登记过（数据库中已存在）
REASON=4，表示要注销的号码或群号不存在（数据库中没有此记录）
REASON=5，表示酒店数已超过200，不允许再登记
REASON=7，表示数据库操作错误
举例：
登记号码为4820001命令：
#STARTFEEENQAction=REG:
Num=4820001*
登记群号为55命令
#STARTFEEENQAction=CTXREG:
Num=55*
撤销号码为4820001命令：
#STARTFEEENQAction=DEL:
Num=4820001*
撤销群号为55命令
#STARTFEEENQAction=CTXDEL:
Num=55*
注意事项：
如果按群号登记，将比较话单中的群号（CtxNo）与登记的群号是否相等，相等则发送；如果按号码登记，将比较话单中的付费号码（PayNo）与登记的号码是否一致，相等则发送。
对同一个酒店，一张话单最多只向酒店发送一次。
在GUI界面上，如果撤销酒店，则这个酒店下所有的登记的号码都撤销登记了,酒店资源就释放了。
重新登记这个酒店相当于登记了一个新的酒店。
1.1.0版本开始，酒店登记和撤销不再需要发送上述命令，只要在GUI界面上登记或撤销即可。
为了兼容以前的酒店管理系统，如果发送登记或撤销命令到大客户系统，都会回一个成功消息。
4.1.2启动立即计费话单发送
功能：
大客户系统接收该命令后启动向酒店系统发送话单。
输入：
#STARTRESTARTCHARGE*
响应：
#STARTRESTARTCHARGEACKOK*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
大客户立即计费服务器收到启动立即计费话单发送命令后，就会发送话单，并返回响应信息。
4.1.3停止立即计费话单发送
功能：
大客户系统接收该命令来决定是否停止向酒店系统发送话单。
输入：
#STARTSTOPCHARGE*
响应：
#STARTSTOPCHARGEACKOK*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
使用本命令停止话单传送后，需要发送#STARTRESTARTCHARGE*命令启动话单传送
4.1.4话单的实时传送
功能：
交换机通过该消息实时的把酒店客房分机产生的话单发送到酒店系统中去。
回应：
#START$CHARGE$Aid$CallingNum$CalledNum$Bearerserv$StartTime$TimeLen&Fee0$fee1$fee2$fee3$fee4$fee5$fee6$fee7$fee8$*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
Aid:
流水号，流水号最大为32767;
START$CHARGE：
话单开始符
CallingNum：
话单中的付费号码
CalledNum：
话单中的被叫号码
Bearerserv：
承载业务
StartTime：
通话开始时间，格式YYYY-MM-DDhh:
mm:
ss
TimeLen：
通话时长，单位为秒
Fee0：
代表总费用,单位为元;格式：
a.bc如2.78,1.00
fee1～8代表个子费用,单位为元;格式：
a.bc
举例：
#START$CHARGE$1001$4820001$5820001$0
$2007-09-1711:
22:
33$120&0.60$0.60$0$0$0$0$0$0$0$*
表示：
流水号为1001，付费号码为4820001，被叫号码为5820001，承载业务为0，开始时间为2007-09-1711:
22:
33，通话时长为120秒，总费用为0.6元，费子项1为0.6元，其他费子项为0。
注意事项：
大客户立即计费系统采用停等协议发送话单，必须收到正确回应的流水号后，才会发送下一下条记录，否则一直发送这张话单，这时第三方酒店程序收到这张重复话单后需要回一个#STARTCHARGEACKAid*给大客户系统，（Aid为这张话单对应的流水号），流水号在0开始到32767之间循环。
每次增1，当到32767后，下次再从0开始。
4.1.5话单传送返回
功能：
接口酒店通过该消息返回流水号,用于确认话单数据有没有收到.
输入：
#STARTCHARGEACKAid*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
Aid：
为收到的话单记录上的流水号，需要第三方酒店程序每次收到话单后，回一个#STARTCHARGEACKAid*给大客户系统
举例：
如收到话单：
#START$CHARGE$1001$4820001$5820001$0
$2007-09-1711:
22:
33$120&0.60$0.60$0$0$0$0$0$0$0$*
应回应：
#STARTCHARGEACK1001*
4.1.6话单重传
功能：
大客户系统接收该命令查找符合条件的话单向酒店重发。
输入：
#STARTRESENDAction=?
:
NUM=?
:
STIME=?
:
ETIME=?
*
响应：
#STARTRESENDRTN=?
*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
Action的值:
REG按付费号码查找重传话单
CTXREG按群号查找重传话单
NO重传与群号和付费号码无关，只与时间有关，此时号码（NUM）
填写0
NUM号码或群号
STIME时间开始段YYYYMMDDhhmmss
ETIME时间结束段
RTN的值:
0:
成功
1:
忙（正在检查重传话单的处理）
2:
有重传话单还没有传完
举例：
如要重传号码为4820001，2006年8月15日的话单
#STARTRESENDAction=REG:
NUM=4820001:
STIME=20060815000000:
ETIME=20060815235959*
如要重传2006年8月15日到8月17日的全部话单
#STARTRESENDAction=NO:
NUM=0:
STIME=20060815000000:
ETIME
=20060817235959*
4.1.7输出话单重传数量
功能：
大客户系统向酒店发送需要重传的话单数量
输出:
#STARTRESENDRTN=?
$BILLCOUNT=?
*
说明：
“#”表示命令的开始符号，“*”表示命令的结束符号，默认情况下开始符号为“#”，结束符号为“*”，也可通过人机命令重新设置（参考上面的人机命令7952-7955）。
RTN：
0--查找操作成功,文件数为BILLCOUNT后面给出的数,
1--表示查找的备份文件坏，或文件不存在
2--文件队列中要发送的文件太多，稍后再重发送重发指令
BILLCOUNT：
查找操作成功后统计出的重传话单数量，如为0表示没有
满足条件的话单
注意:
当大客户系统收到话单重传命令后，首先回应一个消息（参考4.1.6说明）,，然后发送话单数量（重传话单数量为已经发送过的符合条件的话单,对于还没有发送的话单，不在重传统计之内），最后发送需要重传的话单。
4.1.8握手消息
功能：
第三方酒店向大客户系统发送握手消息。
输入：
#STARTRESTARTCHARGE*
响应：
#STARTRESTARTCHARGEACKOK*
说明：
“启动立即计费话单发送”同时可以作为第三方酒店系统定时向大客户系统发送握手消息，间隔建议1分钟，可根据需要进行调整。
第三方酒店系统向大客户系统发送#STARTRESTARTCHARGE*，大客户系统回应#STARTRESTARTCHARGEACKOK*，表示双方通信正常。
若大客户系统超时不回应，则表示通信中断。
通信中断后，建议第三方酒店缩短握手时间，建议每20s发送#STARTRESTARTCHARGE*，一旦收到大客户系统回应#STARTRESTARTCHARGEACKOK*，表示链路恢复。
链路恢复后，大客户系统将自动恢复向第三方酒店传送话单。
4.1.9话单格式
送到酒店的话单内容项及其格式可以通过工具BillConfig.exe进行配置。
如果没有配置则按照默认的格式输出。
（1）默认格式
#START$CHARGE$Aid$CallingNum$CalledNum$Bearerserv$StartTime$TimeLen&Fee0$fee1$fee2$fee3$fee4$fee5$fee6$fee7$fee8$*
说明：
START$CHARGE：
话单开始符
Aid：
流水号，大客户送过来的话单流水号
CallingNum：
话单中的付费号码
CalledNum：
话单中的被叫号码
Bearerserv：
承载业务
StartTime：
通话开始时间，格式YYYY-MM-DDhh:
mm:
ss
TimeLen：
通话时长，单位为秒
Fee0：
代表总费用,单位为元;格式：
a.bc如2.78,1.00
fee1～8代表个子费用,单位为元;格式：
a.bc
（2）定制话单格式
运行BillConfig.exe配置程序，打开“功能->话单项配置”如下图所示：
其中：
●可选话单项——表示原始话单信息
●输出项——表示输出格式中包含的话单内容项及其顺序
●分隔符——表示输出格式中项与项之间的分隔符，必选
●时间格式——表示输出的开始时间或结束时间项的格式，必选
●开始项——表示输出格式中开始部分，如不选表示为空
●结束项——表示输出格式中结束部分，如不选表示为空
●项前缀——表示输出格式中每项的前缀，如不选表示为空
可选的话单项如下：
主叫号码——原始话单中的主叫号码
被叫号码——原始话单中的被叫号码
开始时间——格式按配置的格式
结束时间——格式按配置的格式
时长（秒）——通话时长，单位为秒
付费号码——收费的号码
总费用——单位为元;格式：
a.bc如3.21
费子项1——单位为元;格式：
a.bc
费子项2——单位为元;格式：
a.bc
费子项3——单位为元;格式：
a.bc
费子项4——单位为元;格式：
a.bc
费子项5——单位为元;格式：
a.bc
费子项6——单位为元;格式：
a.bc
参考主叫号码——计费分析时用的主叫号码
参考被叫号码——计费分析时用的被叫号码
业务类别——话单中的业务类别
入中继群
出中继群
连接号码
主叫分析标记
被叫分析标记
承载业务
终端业务
终止原因
时钟变化标志
计费标志
补充业务
计费方标识
CTX群标识
注意事项：
a.输出到酒店的话单内容除开始项外的第一项固定为流水号,界面上不需要配置
b.话单项中补充业务ss的内容包含7个字节,输出格式"0x1234567890abcd"
中高位在前,低位在后,如上面例子中0x12为ss[6],0xcd为ss[0]
c.配置保存后，需要重启接口机才会生效
4.1.
升级会员 