Create a New Guest Message
POST {{HostName}}/rsv/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/guestMessages
HPI-GuestMessages - Post new Guest text message to PMS
/rsv/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/guestMessages
External system sends a new guest text message to the PMS for a specific checked in reservationId.
messageText = Guest message text to store in PMS
messageDate = Date and Time the message has been created
typeOfMessage = Tm
= text message
operator =
deliveryStatus = Nr
- not received
textMessageSentBy = App Id / name
In response of the POST new message the PMS sends a Message Id
id: xxx
Request Body
{"hotelId"=>"{{HotelId}}", "reservationIdList"=>{"type"=>"Reservation", "id"=>"{{ReservationId}}"}, "guestMessages"=>[{"message"=>{"messageText"=>"Text Message content", "messageDate"=>"2022-01-18 10:57:15.0", "typeOfMessage"=>"Tm", "recipient"=>"", "operator"=>"External App"}, "delivery"=>{"deliveryStatus"=>"Nr", "textMessageSentBy"=>"MBOESEL-OHIPSB"}}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
x-hotelid | string | ||
x-app-key | string |