Home / ComXchange / ComXchange PBX Configuration / PMS Interfaces / PMS Protocols and Configuration

PMS Protocols and Configuration

The PMS interface is a communication interface with a Property Management System (PMS) that allows the PMS server to send check-in, check-out, and call restriction information to the ComXchange and the ComXchange to send Room status updates that are entered from a guest room phone.  There can be extra communication between the PMS and the ComXchange such as setting wakeup calls and sending  Call Accounting data along with other PMS information over a single interface when using a Fidelio Interface Application Specification (FIAS) based protocols such as ComXchange FIAS, Hilton, or TigerTMS.

PMS Protocol Types

ComXchange - The default PMS emulation for ComXchange based on the Hitachi protocol
ComXchange FIAS - The ComXchange iteration of the Fidelio Interface Application Specification (FIAS) emulation to communicate with PMS providers or integration partner such as Opera PMS.  This protocol will also work with Jazzware integrations for PEP
Hilton - FIAS based protocol used to communicate with Hilton's PEP or Onq IP interface
MEWS - API interface to communicate with the MEWS PMS
MTL -  Mitel emulation to allow a PMS to communicate with the ComXchange using Mitel Message formatting
TigerTMS - FIAS based protocol used to communicate with PMS partners of TigerTMS integrations such as PEP and OnQ



The default PMS interface configuration is set up to use the ComXchange Protocol and to communicate with the PMS using the Serial port, Com Port 0.  The ComXchange PMS interface will always be a client to the PMS so the ComXchange will initiate the communication.  In its default configuration the ComXchange will send an ENQ to the PMS and will expect to receive an ACK back from the PMS System.  This Acknowledgement is the first sign the two sides are communicating.

PMS Integrations

 Below is a list of some of the PMS companies that the ComXchange can interface with the.  Many will interface using the default configurations with the ComXchange protocol and those with known exceptions are noted.
  • Amedeus - Will use ComXchange FIAS emulation
  • Agilysys
  • Choice
  • Choice Advantage
  • Chorum
  • Cloud Beds
  • Fosse - Marriot  - Fosse will need to have some message options disabled for communication to work
  • FSPMS - Marriott Full Service - There is an option to remove leading characters from the name field that can be used
  • InnQuest/Roommaster
  • Infor HMS
  • LightSpeed
  • Maestro
  • Megasys HMS
  • Mews - Will use Mews Emulation
  • OnQ - 
  • Opera  - Can use ComXchange or ComXchange FIAS
  • Pep – Hilton OnQ replacement - has used Mitel Emulation for a serial connection, but  currently uses tigertms emulation for integration with TigerTMS or ComXchange FIAS emulation for integration with  Jazzware
  • Sky Touch
  • Springer-Miller
  • SynXis
  • Visual Matrix
  • Comtrol Loging Link Integrations - Comtrol is an interface integration company, for ComXchange to PMS connectivity they will have hardware with a serial or IP connection on premise and should use ComXchange emulation.  See Comtrol's list of PMS partners: Comtrol-property-management-systems-partners

ComXchange Protocol

The ComXchange protocol is a communication protocol based on the Hitachi interface protocol and can use either serial ports or an IP connection.  The ComXchange protocol will exchange guest data and room status information, it will not communicate information about call charges or wakeup calls over the interface.  There are messages that are used set up and monitor the communication of the interface and there are message sent to or from the PMS that contain the data to be exchanged.   Messages containing text data will begin with a STX (start of text field) and end with an ETX (end of text field)

ComXchange Communication and Link Control

In a default configuration, when the ComXchange Interface initially starts up it will send an ENQ followed by a LINETEST message.  Once an ACK message is received from the PMS normal transmission can begin.   Anytime the ComXchange sends a message to the PMS it expects a response of ACK or NAK
  • ENQ -  Enquiry message
    • Bi-directional enquiry message is used to begin communication and should receive an ACK before communication will continue
  • ACK - Acknowledge message
    • Bi-directional message used to respond to the receipt of a valid message
  • NAK - Negative Acknoledge message
    • Bi-directional response to a message indicating that the data was received with errors or was otherwise unreadable
    • Upon receiving a NAK from the PMS the ComXchange will attempt to send the data two more times if a NAK is received for all them the PMS will be considered out of service
  • LINETEST -  [STX]LINETEST[ETX]
    • Data message sent from the ComXchange used to verify data can be transmitted successfully over a link before the link is considered active and other communication can begin
    • This can be disabled by disabling the PBX Up message option 
  • AREYOUTHERE - [STX]AREYUTHERE[ETX]
    • Bi-directional message that is sent periodically to verify the link is still active
    • To send this from the ComXchange set the Link Alive Interval message option to a number other than 0 
  • RQINZ - [STX]RQINZ[EX]
    • Request resync message sent from the ComXchange requesting that the current PMS database information be sent from the PMS 

ComXchange Guest Records

  • CHK1 / CHK0 - Guest Check In Message / Guest Check Out Message
    • Sent from the PMS
    • [STX]CHK2[]105[][]Engel,[]Alyssa[][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][ETX]
  • DND1 / DND0 - Do Not Disturb On Message / Do Not Disturb Off Message
    • Sent from the PMS
    • [STX]DND1[]105[][][ETX] / [STX]DND0[]105[][][ETX]
  • VIP1 / VIP0 - VIP on Message / VIP off Message
    • Sent from PMS
    • [STX]VIP1[]105[][][ETX] / [STX]VIP0[]105[][][ETX]
  • RST0 - RST3 - Call Restriction Messsages to set the Class of Service for the Guest extension
    • Sent from the PMS
    • Levels are 0 - Class of Service Unrestricted, 1 - Class of Service Restricted, 2 - Class of Service Local Operator, 3 Class of Service Local Only
    • [STX]RST0[]105[][][ETX],  [STX]RST1[]105[][][ETX],  [STX]RST2[]105[][][ETX],  [STX]RST3[]105[][][ETX]
  • EDT1 / 2 - Edit Guest Name Message / Room Move Message
    • Sent from the PMS
    • [STX]EDT1[]200[][]Engel,[]Dawn[][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][][ETX]  /  [STX]EDT2[]105[][]110[][]A[ETX]
  • STS 0-9 - Room Status Codes 0-9
    • Sent from the ComXchange to the PMS
    • Default feature code is *2 followed by a single digit.  The meaning of each status is mapped in the PMS
    • [STX]STS2[]110[][][ETX]
Many PMS interfaces will use the ComXchange protocol in its default configuration using a com port or an IP connection.
Navigate to Guest Management > Interfaces - Edit the PMS interface
General Tab
  • Protocol - Choose  ComXchange from the Drop Down
  • ENQ Protocol Enabled - Set to Yes
  • ACK/NAK Protocol - Set to Yes
Set your communication to use Com Port 1 or an IP and port to communicate with the PMS server
2025-02-17_16h22_26   2025-02-17_16h22_53

FIAS Protocol Information

FIAS (Fidelio Interface Application Specification) based protocols use a flexible universal protocol that can be used by different property systems to exchange data with vendors such as the ComXchange.  It allows for a property system to define data records using a list of available record types to be supported within an interface.  The ComXchange will use these LR record types (Link records) to define what information will be exchanged over the interface by passing the LR's to the PMS.  The PMS will then be able to provide the related information needed for each action between the PMS and the Phone system such as Check in and Check out actions, Room Restrictions, Rooms Status changes and call charge records. 

FIAS Communication and Link Control Records

  • LS - Link Start Record
  • LA - Link Alive Record
  • LE - Link End Record
  • LD - Link Description Record
  • LR - Link Record 

These records control the start, operational, and end status of the interface with a defined order of record exchanges.  If either side stops the interface a Link End record should be sent to let the other side know the communication is ending. 
The exchange will start with a LS or Link Start record exchange between the ComXchange and the PMS.  The ComXchange will send an LS record  to the PMS, the PMS will then reply with an LS Record.  Once the LS record from the PMS is received the ComXchange will send a Link Description Record that indicates the start of the LR records.  When the the LR records are done the ComXchange will send a LA Link Alive message to let the PMS know the link is now considered active.
2025-02-05_10h15_17

FIAS Database Records

  • DR - Database Resync Request Record
    • Sent from ComXchange
    • DR|DA170623|TI070000|
  • DS - Database Resync Start Record
    • Sent from the PMS
    • DS|DA170623|TI070000|
  • DE - Database End Record
    • Sent from the PMS
    • DE|DA170623|TI070000|                 

FIAS Guest Data Records 

These records will deal with guest room information such as check in, check out, Voicemail notification, etc.  Below are common Guest data records and an example of the record type.
  •  GI - Guest Check In Record
    • Sent from the PMS
    • GI|RN310|G#102|GNMr.Leon|GLEA|GVN|GGA1|CS1|GA170623|GD170625|GSN|SF
  • GO - Guest Check Out Record
    • Sent from the PMS
    • GO|RN310|G#1023|GSN|
  • GC - Guest Info Change Record
    • Sent from the PMS
    • GC|RN310|G#102|GNMr.Leon|GLEA|GVN|GGA1|CS1|GA170623|GD170625|GSN|
  • GC - Guest Room Change Record
    • Sent from the PMS 
    • GC|G#1023|GNMr.Leon|GLEA|GVN|GGA1|CS1|GA170623|GD170625|RN322|GSN|RO310|GSN|
  • RE - Voicemail Notification Record
    • Sent from the PMS
    • RE|RN310|VM0000|
  •  RE - Message Light Status Message
    • Sent from the PMS
    • RE|RN310|MLY|
  • RE - Do Not Disturb Record
    • Sent from the PMS
    • RE|RN310|DNY|
  •  RE - Room Status Record
    • Sent from ComXchange
    • RE|RN310|RS3|  
  • WR - Wakeup Request Record
    • Sent from the PMS
    • WR|RN310|DA170623|TI070000|
  • WA - Wakeup Answer Record
    • Sent from ComXchange
    •  WA|RN310|DA170623|TI070000|ASBY|
  • WC - Wakeup Clear Record
    • Sent from the PMS
    • WC|RN310|DA170623|TI070000|

FIAS Charge Posting Records

  • PS - Posting Simple Record
    • Sent from the ComXchange to the PMS upon a billable guest call
    • PS|RN310|TA1050|DA170623|TI070000|DU001550|P#1729|DD6087731000|PCL|CTLocal|PTC|
  • PA - Posting Accepted Record
    • Sent from the PMS upon posting acceptance
    •  PA|RN310|ASOK|P#1729|DA170623|TI070000|     

Hilton Protocol

The Hilton Protocol is a FIAS based protocol that is used to communicate with Hilton's PEP PMS interface over an IP Connection.
Navigate to Guest Management > Interfaces - Edit the PMS Interface 

Hilton PMS Interface - General Tab

  • Protocol - Choose  Hilton from the Drop Down
  • ENQ Protocol Enabled - Set to No
  • ACK/NAK Protocol - Set to No
  • IP Enabled - Set to Yes
  • Remote Host/IP - Set to the IP address of the PEP server provided by the property/Hilton
  • Remote TCP Port - Set to the port to communicate with the PEP server provided by the property/Hilton 
  • TCP Keep Alive Interval - Set to 3000
  • Call Charge Forwarding  - Set to Yes.  This will allow chargeable calls from the Call Accounting server to be sent over the Hilton Interface.
  • TCP Port -   Set to an available TCP port such as 62502.  This port will listen for data being sent from the Call Accounting server that will match this port

Hilton PMS Interface - Message Options Tab

  • Keep Alive Interval - Set to 300000 (five minutes)
2025-02-12_15h14_46   2025-02-14_15h25_01

Hilton Call Accounting Settings

For the Call Accounting Charges to be sent over the Hilton Interface, the Call Accounting PMS Communication Parameters will need to be configured to be sent to the Call Charge Forwarding TCP port that was set up in the Hilton PMS interface - General tab and the TOC Letter Output will need to be configured to match Hilton's required numbering for Types of Calls
Navigate to Reports > Call Accounting > Admin > PMS 
Communication Params Tab
  • Choose the TCP option 
  • Set the Com/TCP Port to 62502 (should match the Call Charge Forwarding TCP Port)
  • Set IP Address to 127.0.0.1
TOC Letter Output Tab
  • Local - 1
  • Intrastate - 2
  • Interstate -3
  • International - 4
  • Alaska -4
  • Hawaii - 4
  • Canada - 4
  • Mexico - 4
  • Caribbean - 4
  • International - 4
  • Intralata Interstate - 2
  • Intralata Intrastate - 2 
2025-02-14_16h09_21  2025-02-14_16h20_42

Mews

Mews is a Cloud Based API interface that Connects with a web socket, http address and Tokens.  The data to be entered into the interface will be provided by Mews or the property that is using their service
2025-02-14_17h02_52

MTL Protocol

The MTL protocol is based on the Mitel protocol and can be used when a PMS is set up to use a Mitel interface so they do not have to change the protocol on the PMS side of the interface.  This can be used for guest information and restrictions as well as room status codes.  The MTL protocol is very similar to the ComXchange protocol but has a few distinct differences such as the Check in message and the room restriction mappings.  
  • Chk1 / Nam1 - Check in Message / Name Message 
    • 2 messages from the PMS sent on check in
    • NAM1[]Allen,[]Robert[][][][][][][][][][]105[ETX] /  [STX]NAM1[]Allen,[]Robert[][][][][][][][][][]105[ETX]
  • AREYUTHERE - Keep alive message
    • Sent from the PMS
    • [STX]AREYUTHERE[ETX]
The Mitel protocol also uses different codes for Class of service.
  • RST0 - RST5 - Call Restriction Messsages to set the Class of Service for the Guest extension
    • Sent from the PMS
    • Levels are 0 - Class of Service Restricted, 1 - Class of Service Local Operator, 2 - Class of Service Unrestricted, Levels 3 through 5 are option 1, 2 and 3
    • [STX]RST0[]105[][][ETX],  [STX]RST1[]105[][][ETX],  [STX]RST2[]105[][][ETX]
the MTL protocol shoul dbe compatible with the PMS interface default configurations other than choosing MTL in the Protocol drop down 
Navigate to Guest Management > Interfaces - Edit the PMS interface
General Tab
  • Protocol - Choose MTL from the Drop Down
  • ENQ Protocol Enabled - Set to Yes
  • ACK/NAK Protocol - Set to Yes
Set your communication to use Com Port 1 or an IP and port to communicate with the PMS server

Opera - FIAS

The Opera Protocol is a FIAS based protocol that is used to communicate with the Opera PMS interface over an IP Connection.


Opera Call Accounting Settings

For the Call Accounting Charges to be sent over the Opera PMS server the Call Accounting PMS Communication Parameters will need to be configured to be sent to the Call Charge Forwarding TCP port that was set up in the Opera PMS interface - General tab
Navigate to Reports > Call Accounting > Admin > PMS 
Communication Params Tab
  • Choose the TCP option 
  • Set the Com/TCP Port to 62502 (should match the Call Charge Forwarding TCP Port)
  • Set IP Address to 127.0.0.1
2025-02-14_16h09_21

TigerTMS 

The TigerTMS Protocol is a FIAS based protocol that is used to communicate with a TigerTMS device over an IP Connection.  The Tiger TMS interface has an additional Parameter of (GF) guest forename in the check in string.  In the example below it is GFJane and GN Smith, rather that the GN containing both names.
  • [STX]GI|RN105|G#123333|GTMiss|GNSmith|GFJane|GG|GLEN|GV1|GA240205|GD240206|VR|GSN|DA240205|TI173736|[ETX]

Tiger TMS Interface - General Tab

  • Protocol - Choose  TigerTMS from the Drop Down
  • ENQ Protocol Enabled - Set to No
  • ACK/NAK Protocol - Set to No
  • IP Enabled - Set to Yes
  • Remote Host/IP - Set to the IP address of the TigerTMS device provided by the property
  • Remote TCP Port - Set to the port to communicate with the Tiger TMS device provided by the property
  • TCP Keep Alive Interval - Set to 5000
  • Call Charge Forwarding  - Set to Yes.  This will allow chargeable calls from the Call Accounting server to be sent over the Hilton Interface.
  • TCP Port -   Set to an available TCP port such as 62502.  This port will listen for data being sent from the Call Accounting server that will match this port
2025-02-14_16h42_46

TigerTMS Call Accounting Settings

For the Call Accounting Charges to be sent over the TigerTMS device, the Call Accounting PMS Communication Parameters will need to be configured to be sent to the Call Charge Forwarding TCP port that was set up in the TigerTMS PMS interface - General tab
Navigate to Reports > Call Accounting > Admin > PMS 
Communication Params Tab
  • Choose the TCP option 
  • Set the Com/TCP Port to 62502 (should match the Call Charge Forwarding TCP Port)
  • Set IP Address to 127.0.0.1
2025-02-14_16h09_21

Fosse PMS Interface Configuration

The Fosse PMS interface uses the ComXchange Protocol with a number of message options disabled as the Fosse PMS will not reply to specific messages or will send a NAK in reply that will set the interface as out of service.  
Navigate to Guest Management > Interfaces - Edit the PMS interface
General Tab
  • Protocol - Choose  ComXchange from the Drop Down
  • ENQ Protocol Enabled - Set to Yes
  • ACK/NAK Protocol - Set to Yes
Set your communication to use Com Port 1 or an IP and port to communicate with the PMS server
Message Options Tab
You will need to disable the following message options:
  • Guest Data Options
    • VIP
  • Guest Voicemail Options
    • Outbound Message Count Update During Sync
    • Text Message Update
  • Guest Wakeup Options
    • Set
    • Clear
    • Query
    • Update
  • Link Options
    • PBX Up
  • Sync
    • Request
2025-02-17_16h32_13












    		 RSS of this page