Get Conversation Details

get https://api.hostex.io/v3/conversations/{conversation_id}

This endpoint is used to retrieve the messages and details of a conversation.

We are constantly improving our API which could mean that message schema may change. In order to maintain a healthy integration, your Application must parse and ignore unexpected parameters instead of throwing errors.

Response

Response body

object

request_id

string

required

Unique identifier for the request.

error_code

integer

required

Numeric error code representing the status of the response. A value of 200 indicates success.
See the Error Codes section for more information.

error_msg

string

required

Message detailing the status of the response.

data

object

required

string

required

The id of the conversation.

channel_type

string

required

The type of the channel. See Supported Channels for more information.

airbnb booking.com agoda expedia vrbo trip.com booking_site tujia_intl hostex_direct tujia xiaozhu meituan_bnb meituan_hotel muniao fliggy zhukeyun tiktok xiaohongshu ctrip houfy

guest

object

required

The guest's information.

activities

array of objects

required

A list of activities associated with the conversation.

activities*

object

activity_type

string

The type of activity.

inquiry reservation

reservation_code

string | null

The reservation code related to the activity, if applicable.

check_in_date

date | null

The check-in date related to the activity.

check_out_date

date | null

The check-out date related to the activity.

listing_id

string | null

The listing id related to the activity.

property

object | null

Details of the property related to the activity.

note

string

Any notes related to the conversation.

messages

array of objects

required

List of messages within the conversation.

messages*

object

string

The id of the message.

sender_role

string

The role of the message sender, either 'host' or 'guest'.

display_type

string

The display type of the message.

content

string

The text content of the message.

attachment

object | null

Any attachment included with the message.

Has additional fields

created_at

date-time

The timestamp of when the message was created.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.hostex.io/v3/conversations/conversation_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json