Протокол PMS 3CX

Введение

В этой главе описан протокол PMS, предназначенный для интеграции с ПО для управления недвижимостью PMS. Протокол 3CX PMS похож на Mitel PMS или Oracle Micros-Fidelio, поэтому в вашей системе PMS можно выбрать протокол Mitel PMS (SX2000) или FIAS. Здесь подробно рассматривается протокол Mitel, а протокол Micros-Fidelio стандартизован компанией Oracle Micros.

Сертификация 3CX для Micros FIAS

3CX получил сертификат от компании Micros-Fidelio, подтверждающий совместимость АТС 3CX с функциями PMS FIAS.

Общая информация о протоколе Mitel

Двунаправленный (сквозной полудуплексный) канал связи PMS/АТС использует протокол ENQ/ACK/STX-text-ETX/ACK. Последовательность передачи данных от PMS к АТС следующая:

Передача сообщения завершена.

На последовательности передачи накладываются ограничения по времени.

Максимальное время ожидания ACK после передачи STX + msg + ETX - 3 секунды.

Передача информации из PMS в систему

После получения символа ENQ от PMS, АТС в течение трех секунд отвечает либо ACK, либо NAK. ACK означает, что передача прошла успешно. NAK указывает на ошибку передачи или на то, что система сейчас занята. При этом генерируется запись в логе отельного модуля об ошибке. После отправки ACK АТС немедленно готова к приему STX, содержимого сообщения и ETX. В течение трех секунд после получения ETX она отвечает следующим образом:

• ACK указывает на то, что передача прошла успешно и все поля сообщения достоверны.
• NAK указывает на ошибку в физической передаче, в одном из полей сообщения или в синтаксисе сообщения (в частности, STX, ETX, код функции и код состояния. Например, вместо CHK1 отправлено CHK3). Система формирует запись в логе с указанием ошибки. 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, обозначающий отрицательное подтверждение Negative Acknowledge).

Пример:

Check In: (регистрация для добавочного номера 100)

STXCHK1 100ETX (где STX = 2, ETX = 3), в результате возникает следующее сообщение 2CHK1 1003

Сообщение об имени гостя

Это сообщение передается из PMS и используется для отображения имени гостя на телефоне. Сообщение с именем имеет следующий формат ввода:

NAM: Код функции имени.

NAME: Символы имени (не более 21 символа).

n: Добавочный номер.

Длина имени (до 21 символа) форматируется по левому краю, а пробелы используются для заполнения. Символы могут быть как в верхнем, так и в нижнем регистре, а также могут включать цифры. Могут передаваться имя и фамилия (разделенные запятой, расположенной в любом месте, кроме 1-го и 21-го). Если указано только имя, по умолчанию оно представляется как фамилия гостя. В строке сначала идет фамилия, а потом имя. Если указано только имя, то 21-м символом будет пробел (максимальная длина имени - 20).

Использование кода строковой операции позволяет связывать / отвязывать имя гостя и добавочный номер в комнате.

Система позволяет добавлять на номер более одного имени, но, как правило, с номером связано только одно имя.

1. (addition) - имя добавляется в текущий список имен для данного номера. Если на данном номере нет имени, создается новая запись в телефонной книге.
2. (replacement ) - имя используется для ЗАМЕНЫ первого (в алфавитном порядке) имени для данного номера. Остальные имена для номера не изменяются

Если от PMS получено недопустимое сообщение, система возвращает NAK.

Сообщения для будильников

PMS система может информировать АТС об установке сигналов-будильников для конкретной комнаты. Такое сообщение имеет следующий формат:

t: время пробуждения

n: Добавочный номер.

Время пробуждения указывается в 24-часовом формате. Все четыре символа, заполненные ASCII пробелами (т.е. пустые), - это удаление времени пробуждения (формат времени: HHmm).

Пример установки будильника на 23 часа 30 минут на внутренний номер 100:

2MW 2330 1003

Сообщение статуса DND

PMS может сообщить АТС о необходимости установить статус DND для комнаты, отправив следующее сообщение:

КОД СТАТУСА:

• 1 – DND ON
• 0 – DND OFF
• SP - пустой символ ASCII
• Пример: установить DND ON для добавочного номера 302
• 2DND1   3023  STXDND1SPSPSP302ETX
• StxValue = 2
• EtxValue = 3
• ENQ = 5;
• ACK = 6;
• NACK = 21

Сообщение Message Registration (биллинг)

Каждый раз, когда добавочный номер в комнате совершает звонок через внешний транк, система отправляет сообщение в PMS для обновления общего количества внешних вызовов из комнаты. При этом не делается различия между местными и междугородними вызовами. Регистрация сообщений осуществляется путем подсчета количества импульсов за время разговора.

Сообщение Message Registration имеет следующий исходящий формат:

SP: Пустой символ ASCII.

n: Добавочный номер.

Код состояния в этом случае - стоимость. Это единственное исключение в длине кода состояния - 4 байта вместо 2.

Сообщение Station Restriction (ограничения станции)

Сообщение Station Restriction может использоваться для установления ограничений на вызовы. Когда это сообщение отправляется из PMS в АТС, оно активирует заранее установленные ограничения.

Примечание. Вызовы экстренных служб (911/999) и внутренние вызовы никогда не ограничиваются.

Сообщение Station Restriction имеет следующий формат:

RST: Код функции Station Restriction.

X: Добавочный номер или номер комнаты.

S: Код состояния:

• 0 - Internal
• 1 - Local
• 2 - Long Distance

StxValue = 2

EtxValue = 3

ENQ = 5;

ACK = 6;

NACK = 21

Сообщение Maid Status (статус уборки комнаты)

Сообщение статуса уборки используется для того, чтобы горничная могла передавать статус уборки комнаты по телефону. Сообщение о статусе уборки передается звонком из комнаты, вводом диалкода, а затем соответствующего кода уборки.

Например, при наборе "*682" в PMS будет отправлено сообщение о текущем статусе. В результате статус комнаты будет установлен в "убрано".

Сообщение о статусе уборки имеет следующий формат:

X: Код состояния уборки.

SP: Пустой символ ASCII.

n: Добавочный номер (до 5 цифр).

При наборе АТС посылает в PMS код функции и код статуса. PMS интерпретирует коды следующим образом:

Сообщение Occupancy Condition (состояние комнаты)

• STS1 - Maid Present (горничная в номере)
• STS2 - Clean (убран)
• STS3 - Not Clean (не убран)
• STS4 - Out of Service (не обслуживается)
• STS5 - To be Inspected (должен быть проверен)
• STS6 - Occupied/Clean (занят/убран)
• STS7 - Occupied/Not Clean (занят/не убран)
• STS8 - Vacant/Clean (свободен/убран)
• STS9 - Vacant/Not Clean (свободен/не убран)

Версия документа

Последнее обновление документа 18 июля 2022

https://www.3cx.ru/docs/3cx-pms-protocol/