3CX PMS-Protokoll-Spezifikation

Einführung

Dieser Artikel befasst sich mit dem 3CX PMS-Protokoll, das mit PMS-Software für Hotels integriert ist. Es ist dem Mitel PMS-Protokoll oder Oracle MICROS-Fidelio sehr ähnlich, daher kann das Mitel PMS (SX2000)- oder FIAS-Protokoll im PMS/3CX System spezifiziert werden. Das Mitel-Protokoll soll nachfolgend näher betrachtet werden. Ausführlichere Informationen zum MICROS-Fidelio-Standard entnehmen Sie bitte der Oracle MICROS-Herstellerdokumentation.

MICROS FIAS Vendor Record Specification Form (VRSF)

3CX hat das Interoperabilitätsprogramm von MICROS-Fidelio durchlaufen und die entsprechende Zertifizierung erhalten.

Allgemeine Informationen zum Mitel-Protokoll

Die bidirektionale PMS-3CX-Verbindung (Halbduplex-Übertragung) nutzt das ENQ/ACK/STX-text-ETX/ACK-Protokoll. Die PMS-3CX-Übertragungssequenz sieht wie folgt aus:

Die Nachricht wird vollständig übertragen.
Für die Übertragungssequenzen gelten jedoch Zeitlimits:

Ein ACK nach einer STX+msg+ETX-Übertragung muss innerhalb von maximal 3 Sekunden erfolgen.

Übertragung vom PMS zur 3CX Telefonanlage  

Nach dem Empfang eines ENQ-Zeichens vom PMS antwortet das 3CX System innerhalb von 3 Sekunden mit einem ACK oder NAK (ACK bei einer erfolgreichen Übertragung, NAK bei einem Übertragungsfehler oder bei einem ausgelasteten 3CX System). Vom 3CX System wird ein hotelspezifisches Protokoll erstellt, in dem der Fehler erfasst wird. Nach dem Senden von ACK kann das 3CX System umgehend STX, Nachrichtentext und ETX empfangen. Innerhalb von 3 Sekunden nach dem ETX-Empfang antwortet das 3CX System entweder mit:

• ACK – die Übertragung war erfolgreich, alle Nachrichtenfelder sind gültig – oder mit
• NAK – bei der eigentlichen Übertragung, in einem der Nachrichtenfelder oder in der Nachrichtensyntax trat ein Fehler auf (STX, ETX, Funktions- und Statuscode. Beispiel: CHK3 wird statt CHK1 gesendet). Vom System wird ein hotelspezifisches Protokoll erstellt, in dem der Fehler erfasst wird. Dem PMS ist es möglich, nur den Nachrichten-TXN (STX, Nachrichtentext und ETX) drei weitere Male erneut zu senden, ohne dass dieser einem ENQ folgt.

Das folgende Beispiel zeigt einen erneuten PMS-Übertragungsversuch:

Anschließend verwirft das PMS die Übertragung.

Spezifizierung des PMS-Formats

Die Nachrichten sind allgemein im folgenden Format gehalten:

Nachricht zum Check-in-/Check-out

Die Nachricht ist wie folgt aufgebaut:

X: Steht für den Check-in-/Check-out-Statuscode

• ASCII-Zeichen 1 für Check-in
• ASCII-Zeichen 0 für Check-out

SP: Steht für das ASCII-Leerzeichen. n steht für eine einzelne Nebenstellenziffer.

Hinweis: Nebenstellennummern mit weniger als 5 Ziffern werden mit Leerzeichen aufgefüllt (ASCII 32, HEX 20), nicht mit Nullen (ASCII 48, HEX 30).

Ist die vom PMS empfangene Nachricht ungültig, antwortet das 3CX System mit einem NAK (ASCII-Zeichen für 'Negative Acknowledge').

Beispiel:

Check-in: (Check-in für Nebenstelle 100)

STXCHK1   100ETX (mit STX = 2 und ETX = 3) ergibt die Nachricht 2CHK1   1003

Nachricht zum Gastnamen

Die folgende vom PMS gesendete Nachricht zeigt den Namen des Gasts auf dem Zimmertelefon-Display an:

NAM: Steht für den Namen-Funktionscode.
NAME: Besteht aus maximal 21 Zeichen.
n: Steht für eine einzelne Nebenstellenziffer.

Der aus maximal 21 Zeichen bestehende Name ist linksbündig anzugeben, mit Leerzeichen zum Padding. Die Zeichen können groß oder klein geschrieben werden und auch nummerisch sein. Sowohl Vor- als auch Nachname lassen sich angeben (per Komma getrennt, das jedoch nicht an erster und 21. Stelle stehen darf). Wird nur ein Name angegeben, wird dieser standardmäßig als Nachname erfasst. Bei Angabe von Vor- und Nachname muss der Nachname vorangestellt werden. Bei nur einem Namen darf dieser lediglich aus 20 Zeichen bestehen, da das 21. Zeichen aus einem Leerzeichen besteht.

Mit dem String-Operation-Code kann ein Name für eine Zimmertelefon-Nebenstelle hinzugefügt oder entfernt werden.

Das System ermöglicht es, mehr als einen Namen für eine Nebenstelle anzugeben. In den meisten Fällen ist mit einer Nebenstellennummer nur ein Name verbunden.

Beim String-Operation-Code handelt es sich um das erste Byte des Statuscodes mit folgenden Optionen:

1. (Hinzufügen) – Der Name wird der Namensliste, die der Nebenstelle zugewiesen ist, HINZUGEFÜGT. Sollte der Nebenstelle noch kein Name zugewiesen sein, wird ein neuer Eintrag im Telefonverzeichnis erstellt.
2. (Ersetzen) – Der Name wird verwendet, um den alphabetisch an erster Stelle stehenden Namen, der für die Nebenstelle angegebenen ist, zu ERSETZEN. Alle anderen für die Nebenstelle angegebenen Namen bleiben bestehen.

Wird vom PMS eine ungültige Nachricht empfangen, gibt das System ein NAK zurück.

Nachricht zum Weckruf

Das PMS informiert die 3CX Telefonanlage mit Hilfe der folgenden Weckrufnachricht, wenn ein Weckruf über eine Zimmertelefon-Nebenstelle erfolgen soll:

t: Steht für die Weckzeit.

n: Steht für eine einzelne Nebenstellenziffer.

Die Weckzeit wird im 24-Stunden-Format angegeben (im Format 'HHmm'). Wird für alle vier Zeichen ein ASCII-Leerzeichen angegeben, wird die Weckzeit gelöscht.

Beispiel für einen Weckruf um 23.30 Uhr für Zimmertelefon-Nebenstelle 100:
2MW 2330 1003

Nachricht zu Nicht stören (DND)

Das PMS informiert die 3CX Telefonanlage mit Hilfe der folgenden Nachricht, wenn für eine Zimmertelefon-Nebenstelle die Nicht-stören-Funktion (DND) aktiviert werden soll:

STATUSCODE:

• 1 – DND AN
• 0 – DND AUS
• SP steht für ein ASCII-Leerzeichen

Beispiel: DND soll für Zimmertelefon-Nebenstelle 302 aktiviert werden:

2DND1   3023  STXDND1SPSPSP302ETX

• StxValue = 2
• EtxValue = 3
• ENQ = 5;
• ACK = 6;
• NACK = 21

Nachricht zur Nachrichtenregistrierung

Wird über eine Zimmertelefon-Nebenstelle ein Anruf per SIP-Trunk getätigt, sendet die 3CX Telefonanlage die folgende Nachricht zur Nachrichtenregistrierung an das PMS, damit die Gesamtzahl der von der Nebenstelle getätigten externen Anrufe aktualisiert wird. Dabei wird nicht zwischen Orts- und Ferngesprächen unterschieden. Bei der Nachrichtenregistrierung wird die Anzahl der Zählimpulse während eines Gesprächs erfasst:

SP: Steht für das ASCII-Leerzeichen.

n: Steht für eine einzelne Nebenstellenziffer.

Beim Statuscode handelt es sich in diesem Fall um eine Gebühr. Die Länge des Codes ist eine Ausnahme, da sie 4 Byte statt 2 Byte beträgt.

Nachricht zu Zimmertelefon-Rufsperren

Eine Nachricht zu Zimmertelefon-Rufsperren kann ausgehende Anrufe unterbinden. Wird diese Nachricht wie unten angegeben vom PMS an die 3CX Telefonanlage gesendet, werden zuvor programmierte Rufsperren aktiviert.

Hinweis: Die Wahl von Notrufnummern wie 110/112 und hotelinterne Anrufe sind jederzeit möglich.

RST: Steht für den Funktionscode der Zimmertelefon-Rufsperre.

X: Steht für eine einzelne Ziffer der Nebenstellennummer des Zimmetelefons. 

S: Steht für einen der folgenden Statuscodes:

• 0 – Intern
• 1 – Ortsgespräch
• 2 – Ferngespräch

StxValue = 2

EtxValue = 3

ENQ = 5;

ACK = 6;

NACK = 21

Nachricht zum Zimmerstatus (über Zimmerservice/Housekeeping)

Mit einer Nachricht zum Zimmerstatus können Servicekräfte den aktuellen Reinigungszustand per Zimmertelefon durchgeben. Neben dem dafür vorgesehenen Funktionscode ist der aktuelle Statuscode einzugeben.

Beispiel: Durch Wahl von '*682' erhält das PMS die Nachricht, dass das Zimmer sauber ist. Die Nachricht zum Zimmerstatus sieht wie folgt aus:

X: Steht für den Funktionscode zum Zimmerstatus.

SP: Steht für das ASCII-Leerzeichen.  

n: Steht für eine einzelne Ziffer der Nebenstellennummer des Zimmertelefons (bis zu 5 Ziffern).Der gesamte gewählte Code wird an das PMS gesendet. Die einzelnen Statuscodes umfassen:

• STS1 – Reinigung wird durchgeführt
• STS2 – Gereinigt
• STS3 – Nicht gereinigt
• STS4 – Nicht nutzbar
• STS5 – Weitergehende Kontrolle erforderlich
• STS6 – Belegt/Gereinigt
• STS7 – Belegt/Nicht gereinigt
• STS8 – Frei/Gereinigt
• STS9 – Frei/Nicht gereinigt

Letztes Update  

Dieses Dokument wurde zuletzt am 25. Juli 2023 aktualisiert.

https://www.3cx.de/docs/pms-protokoll-specs/