Workflow: Get Guest Message

External system requests current guest messages linked in the PMS for a specific reservation to display the messages on the guest room.

Sequence Diagram


This image shows the sequence of the workflow.

Description of Steps:

  Description of Steps Operation
UC2.1

Use case: External system requests current guest messages for a specific reservation to display the messages on the guest room.

Use the getReservations operation with the fetchInstructions parameter = GuestMessages.

The response message contains the reservationId, Reservation information, guest profile information, and guest message information.

Guest Messages with OPERA Cloud delivery status = "Not Delivered" are returned as not delivered.

After the guest confirms receipt on the external system, change the deliveryStatus to “Mr” (Delivered) and notify OPERA Cloud using put GuestMessages (see UC1.2).

GET reservations

Retrieve Guest Messages for a Reservation

GET {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{reservationId}}?fetchInstructions=GuestMessages

200 Response:

Body: 

{
    "reservations": {
        "reservation": [
            {
                "reservationIdList": [
                    {
                        "id": "2783606",
                        "type": "Reservation"
                    },
                    {
                        "id": "2211656547",
                        "type": "Confirmation"
                    }
                ],
                "roomStay": {
                    "arrivalDate": "2020-08-31",
                    "departureDate": "2020-09-01",
                    "expectedTimes": {
                        "reservationExpectedArrivalTime": "2020-08-31 09:53:28.0",
                        "reservationExpectedDepartureTime": "2020-09-01"
                    },
                    "guarantee": {
                        "guaranteeCode": "CHECKED IN",
                        "shortDescription": "Checked In"
                    }
                },
                "reservationGuests": [
                    {
                        "profileInfo": {
                            "profileIdList": [
                                {
                                    "id": "1962840",
                                    "type": "Profile"
                                }
                            ],
                            "profile": {
                                "customer": {
                                    "personName": [
                                        {
                                            "givenName": "Light Test",
                                            "surname": "Message",
                                            "nameType": "Primary"
                                        }
                                    ]
                                }
                            }
                        },
                        "primary": true
                    }
                ],
                "extSystemSync": false,
                "guestMessages": [
                    {
                        "message": {
                            "messageText": "Dear Mr Guest, Pls call reception. Thank you very much",
                            "messageDate": "2020-08-31 11:57:20.0",
                            "typeOfMessage": "Tm",
                            "recipient": "Message, Light Test"
                        },
                        "delivery": {
                            "deliveryStatus": "Nr"
                        },
                        "id": "346998"
                    }
                ],
                "hotelId": "{{HotelId}}",
                "reservationStatus": "InHouse",
                "createDateTime": "2025-05-14 07:52:12.0",
                "preRegistered": false,
                "allowMobileCheckout": false
            }
        ]
    },
    "masterInfoList": [],
    "links": [
        {
            "href": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/2783606",
            "rel": "self",
            "templated": false,
            "method": "PUT",
            "operationId": "putReservation"
        },
        {
            "href": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/2783606/cancellations",
            "rel": "self",
            "templated": false,
            "method": "POST",
            "operationId": "postCancelReservation"
        },
        {
            "href": "{{HostName}}/fof/v1/hotels/{{HotelId}}/reservations/2783606/roomAssignments",
            "rel": "self",
            "templated": false,
            "method": "POST",
            "operationId": "postRoomAssignment"
        }
    ]
}

Parent topic: Workflows