Skip to main content

Conversation

The Conversation entity is used within the Reservation entity to specify information about the conversation related to the reservation.

Fields​

FieldTypeDescription
idstringOptional. Unique identifier for the conversation.
reservationIdstringOptional. Identifier for the associated reservation.
propertyIdstringOptional. Identifier for the associated property.
typestringOptional. Type of the conversation.
statusstringOptional. Current status of the conversation.
recipientobjectOptional. Information about the conversation recipient.
recipient.namestringOptional. Name of the recipient.
recipient.emailstringOptional. Email of the recipient.
recipient.phonestringOptional. Phone number of the recipient.
recipient.picturestringOptional. Picture of the recipient.
createdAtstringOptional. Creation date of the conversation in ISO 8601 format.
updatedAtstringOptional. Last update date of the conversation in ISO 8601 format.
receivedAtstringOptional. Date when the conversation was received in ISO 8601 format.
subjectstringOptional. Subject of the conversation.
senderTypestringOptional. Role of the entity sending the message. Possible values include Owner/Guest/Log.
bodystringOptional. Body of the conversation.
seenStatusstringOptional. Seen status of the conversation.
is_repliedbooleanOptional. Indicates if the conversation has been replied to.
messagesConversationMessage | ConversationMessage[]Optional. Messages associated with the conversation.
attachmentsConversationMessageAttachment | ConversationMessageAttachment[]Optional. Attachments associated with the conversation.

ConversationMessage​

FieldTypeDescription
idstringOptional. Unique identifier for the message.
conversationIdstringOptional. Identifier of the associated conversation.
reservationIdstringOptional. Identifier for the associated reservation.
propertyIdstringOptional. Identifier for the associated property.
typestringOptional. Type of the message.
bodystringOptional. Body of the message.
statusstringOptional. Current status of the message.
seenStatusstringOptional. Seen status of the message.
is_repliedbooleanOptional. Indicates if the message has been replied to.
senderobjectOptional. Information about the sender of the message.
sender.namestringOptional. Name of the sender.
sender.emailstringOptional. Email of the sender.
sender.phonestringOptional. Phone number of the sender.
sender.picturestringOptional. Picture of the sender.
contentstringOptional. Content of the message.
createdAtstringOptional. Creation date of the message in ISO 8601 format.
updatedAtstringOptional. Last update date of the message in ISO 8601 format.
receivedAtstringOptional. Date when the message was received in ISO 8601 format.
imagesstring[]Optional. Images associated with the message.
attachmentsConversationMessageAttachment[]Optional. Attachments associated with the message.

ConversationMessageAttachment​

FieldTypeDescription
idstringOptional. Unique identifier for the attachment.
messageIdstringOptional. Identifier of the associated message.
reservationIdstringOptional. Identifier for the associated reservation.
propertyIdstringOptional. Identifier for the associated property.
namestringOptional. Name of the attachment.
urlstringOptional. URL of the attachment.
typeobjectOptional. Type information of the attachment.
type.extensionstringOptional. File extension of the attachment.
type.mimeTypestringOptional. MIME type of the attachment.
type.isImagebooleanOptional. Indicates if the attachment is an image.
type.isVideobooleanOptional. Indicates if the attachment is a video.
type.isAudiobooleanOptional. Indicates if the attachment is an audio.

CreateConversationMessageBody​

FieldTypeDescription
conversationIdstringOptional. Identifier of the conversation this message is associated with.
reservationIdstringOptional. Identifier for the associated reservation.
propertyIdstringOptional. Identifier for the associated property.
typestringOptional. Type of the message.
subjectstringOptional. Subject of the message.
bodystringOptional. Body of the message.
statusstringOptional. Current status of the message.
attachmentsConversationMessageAttachment[]Optional. Attachments associated with the message.

CreateConversationMessageBody​

Supported fields in each source system:​

FieldHostawaySmoobuLodgifyBeds24GuestyHostfullyHostifyOwnerRezFantasticStayHospitableHostexBookingSync
idβœ…βœ…-βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
reservationIdβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
propertyIdβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
roomId--βœ…βœ…------πŸ”œ-
typeβœ…--βœ…βœ…βœ…-βœ…-βœ…πŸ”œβœ…
recipient.nameβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
recipient.emailβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
recipient.phoneβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
recipient.pictureβœ…-----πŸ”œ-πŸ”œ-πŸ”œ-
createdAt--βœ…πŸ”œβœ…πŸ”œπŸ”œ-πŸ”œ-πŸ”œβœ…
updatedAtβœ…---βœ…-βœ…-βœ…-πŸ”œβœ…
receivedAt----------πŸ”œ-
messages.idβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
messages.subject-βœ…--πŸ”œπŸ”œ-βœ…--πŸ”œ-
messages.bodyβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
messages.senderTypeβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
messages.createdAtβœ…-βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
messages.updatedAtβœ…--------βœ…πŸ”œβœ…
messages.seenStatusβœ…-βœ…βœ…πŸ”œ-----πŸ”œ-
messages.attachmentsβœ…----βœ…--βœ…βœ…πŸ”œπŸ”œ

βœ… Supported and mapped
πŸ”Ά Partially mapped, not exact match
πŸ”œ Launching soon
β€” Not supported in source system

Supported Methods in each source system​

MethodsHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexBookingSync
Get Conversationsβœ…βœ…βœ…βœ…-βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
Get a Conversationβœ…βœ…βœ…βœ…-βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…
Create Conversation messageβœ…βœ…βœ…βœ…-βœ…βœ…βœ…βœ…βœ…βœ…πŸ”œβœ…

Sample Response​

{
"id": "1234567",
"reservationId": "98765432",
"propertyId": "123456",
"type": "BOOKINGCOM",
"recipient": {
"name": "John Doe",
"email": [
"jdoe.123456@guest.booking.com"
],
"phone": [
"+12345678901"
]
},
"createdAt": "2024-09-01T07:15:38Z",
"updatedAt": "2024-09-01T07:47:04Z",
"messages": [
{
"id": "11111111",
"body": "Thank you very much!\nLooking forward to visiting your beautiful city!",
"senderType": "Guest",
"createdAt": "2024-09-01T07:47:03Z",
"updatedAt": "2024-09-01T07:47:04Z"
},
{
"id": "22222222",
"body": "Smart Conciergerie\n\nBonjour John Doe,\nJ’accuse avec plaisir votre rΓ©servation et j’ai hΓ’te de vous accueillir dans votre appartement Γ  Fontainebleau!\nVoici des informations utiles pour vous permettre de prendre possession des lieux en toute sΓ©rΓ©nitΓ© :\nNom de la location\n\nNew Hypercenter:Appart'HΓ΄tel Sweet Green\n\nAdresse\n\n24 Rue de France, RDC, cour au fond du couloir\n\nCode Postal\n\n77300\n\nVille\n\nFontainebleau\n\nVotre contact Jane Smith: +33 1 23 45 67 89\nAu plaisir de vous accueillir prochainement, Γ  Fontainebleau ! Smart Conciergerie\n\nSmart Conciergerie",
"senderType": "Owner",
"createdAt": "2024-09-01T07:19:03Z",
"updatedAt": "2024-09-01T07:19:03Z"
}
]
}