6 Key Terminology

Term Description
Guest Message Provisioning

In the OPERA Cloud UI, a Guest Message can be provided to the guest by selecting the following options:

Print Message — The message text is printed on paper and not sent to a system handling guest messages on guest rooms.

Text — The message is sent to a defined external message provider who then sends the message to a defined guest phone number (SMS/Text) and not to a system handling guest messages on guest rooms.

Room — Either a notification or the full message text is sent to a connected external system that can notify or display the message in the guest's room.

Note:

Only with option "Room" can a Business Event NEW GUEST MESSAGE be sent out.
Message Status

A Guest Message can have one of the supported message statuses in OPERA Cloud PMS:

  • not delivered — A guest message has been stored in OPERA Cloud, but the guest has not received it. (Received means the guest did not read it or they retrieved it from reception.)
  • delivered — A guest message has been read by the guest or the guest has received the message from reception.
  • deleted — A guest message has been deleted, either by a hotel employee in the OPERA Cloud PMS or through an external system.

The specific deliveryStatus value for not delivered = "Nr"

The specific deliveryStatus value for delivered = "Mr"

Message Id

When an external system sends the post guestMessages operation (as a new Guest Message) to OPERA Cloud PMS, the response (201) message will contain a reference Message Id.

This Message Id is sent with every guestMessages operation to reference the guest message to update (on PUT or DELETE guestMessage).

{
    "guestMessages": [
        {
            "message": {
                "messageText": "You have new Voice Mail. Please check your Phone.",
                "messageDate": "2023-07-07 15:11:31.0",
                "typeOfMessage": "Tm",
                "operator": "PBX",
                "reservationId": {
                    "type": "Reservation",
                    "id": "1023033"
                }
            },
            "delivery": {
                "deliveryStatus": "Nr",
                "textMessageSentBy": "PBX"
            },
            "id": "224997"
        }
    ],
Message with New Line Indicator

Use the \n to define a new line within the messageText string.

"messageText": "This is the first line of a message \r\n. This is the second line of the text."

In OPERA Cloud, the new line appears when the message is in "Edit" status.

This image shows the Guest Messages in "Edit" status with the new line of text.