Conversation
The Conversation
entity is used within the Reservation
entity to specify information about the conversation related to the reservation.
Fieldsβ
Field | Type | Description |
---|---|---|
id | string | Optional. Unique identifier for the conversation. |
reservationId | string | Optional. Identifier for the associated reservation. |
propertyId | string | Optional. Identifier for the associated property. |
type | string | Optional. Type of the conversation. |
status | string | Optional. Current status of the conversation. |
recipient | object | Optional. Information about the conversation recipient. |
recipient.name | string | Optional. Name of the recipient. |
recipient.email | string | Optional. Email of the recipient. |
recipient.phone | string | Optional. Phone number of the recipient. |
recipient.picture | string | Optional. Picture of the recipient. |
createdAt | string | Optional. Creation date of the conversation in ISO 8601 format. |
updatedAt | string | Optional. Last update date of the conversation in ISO 8601 format. |
receivedAt | string | Optional. Date when the conversation was received in ISO 8601 format. |
subject | string | Optional. Subject of the conversation. |
senderType | string | Optional. Role of the entity sending the message. Possible values include Owner/Guest/Log. |
body | string | Optional. Body of the conversation. |
seenStatus | string | Optional. Seen status of the conversation. |
is_replied | boolean | Optional. Indicates if the conversation has been replied to. |
messages | ConversationMessage | ConversationMessage[] | Optional. Messages associated with the conversation. |
attachments | ConversationMessageAttachment | ConversationMessageAttachment[] | Optional. Attachments associated with the conversation. |
ConversationMessageβ
Field | Type | Description |
---|---|---|
id | string | Optional. Unique identifier for the message. |
conversationId | string | Optional. Identifier of the associated conversation. |
reservationId | string | Optional. Identifier for the associated reservation. |
propertyId | string | Optional. Identifier for the associated property. |
type | string | Optional. Type of the message. |
body | string | Optional. Body of the message. |
status | string | Optional. Current status of the message. |
seenStatus | string | Optional. Seen status of the message. |
is_replied | boolean | Optional. Indicates if the message has been replied to. |
sender | object | Optional. Information about the sender of the message. |
sender.name | string | Optional. Name of the sender. |
sender.email | string | Optional. Email of the sender. |
sender.phone | string | Optional. Phone number of the sender. |
sender.picture | string | Optional. Picture of the sender. |
content | string | Optional. Content of the message. |
createdAt | string | Optional. Creation date of the message in ISO 8601 format. |
updatedAt | string | Optional. Last update date of the message in ISO 8601 format. |
receivedAt | string | Optional. Date when the message was received in ISO 8601 format. |
images | string[] | Optional. Images associated with the message. |
attachments | ConversationMessageAttachment[] | Optional. Attachments associated with the message. |
ConversationMessageAttachmentβ
Field | Type | Description |
---|---|---|
id | string | Optional. Unique identifier for the attachment. |
messageId | string | Optional. Identifier of the associated message. |
reservationId | string | Optional. Identifier for the associated reservation. |
propertyId | string | Optional. Identifier for the associated property. |
name | string | Optional. Name of the attachment. |
url | string | Optional. URL of the attachment. |
type | object | Optional. Type information of the attachment. |
type.extension | string | Optional. File extension of the attachment. |
type.mimeType | string | Optional. MIME type of the attachment. |
type.isImage | boolean | Optional. Indicates if the attachment is an image. |
type.isVideo | boolean | Optional. Indicates if the attachment is a video. |
type.isAudio | boolean | Optional. Indicates if the attachment is an audio. |
CreateConversationMessageBodyβ
Field | Type | Description |
---|---|---|
conversationId | string | Optional. Identifier of the conversation this message is associated with. |
reservationId | string | Optional. Identifier for the associated reservation. |
propertyId | string | Optional. Identifier for the associated property. |
type | string | Optional. Type of the message. |
subject | string | Optional. Subject of the message. |
body | string | Optional. Body of the message. |
status | string | Optional. Current status of the message. |
attachments | ConversationMessageAttachment[] | Optional. Attachments associated with the message. |
CreateConversationMessageBodyβ
Supported fields in each source system:β
Field | Hostaway | Smoobu | Lodgify | Beds24 | Guesty | Hostfully | Hostify | OwnerRez | FantasticStay | Hospitable | Hostex | BookingSync |
---|---|---|---|---|---|---|---|---|---|---|---|---|
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β
Methods | Hostaway | Hostify | Smoobu | Lodgify | Uplisting | Guesty | Hostfully | OwnerRez | Beds24 | Hospitable | FantasticStay | Hostex | BookingSync |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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"
}
]
}