Field Type Description id
string Unique alphanumeric identifier for the object. The prefix of the Conversation ID is CVR-
. object
string String representing the object’s type. Objects of the same type share the same value. The value here is conversation
. creation_time
timestamp The date and time the conversation was created. initiated_by
string Either bot
(auto reach out) or contact
(website visitor clicked on a CTA). last_updated_time
string The date and time the conversation was last updated. last_interacted_time
string The date and time of the last conversation interaction. contact
string , expandable The contact / customer involved in this conversation. owner
string , expandable The owner (user object) of the conversation. status
string The status of the conversation. Can be one of the following:started
- The website visitor has responded with a first message and the conversation is active from this point.closed
- The conversation has been closed, this can be done by the conversation ending with a last message, or the visitor starting a different conversation.abandoned
- If there is no response from the visitor for more than 10 minutes the conversation is ended in an abandoned state. bot
string , expandable The bot that facilitated the conversation. website
string , expandable The website this conversation was triggered on. audience
string , expandable The audience associated with this conversation. answers
array[hash] Answers to the questions asked during the conversation. bookings
array[string] Bookings that are associated to the conversation.
Field Type Description id
string Unique alphanumeric identifier for the object. The prefix of the Website ID is WEB-
. object
string String representing the object’s type. Objects of the same type share the same value. The value here is website
. name
string The name of the website. url
string The URL of the website.
Field Type Description id
string Unique alphanumeric identifier for the object. The prefix of the Audience ID is AUD-
. object
string String representing the object’s type. Objects of the same type share the same value. The value here is audience
. name
string The name of the audience.
Field Type Description id
string Unique alphanumeric identifier for the object. The prefix of the Bot ID is BOT-
. object
string String representing the object’s type. Objects of the same type share the same value. The value here is bot
. name
string The name of the bot.
The following is an example of a conversation object.
Sample conversation
{
"object": "conversation",
"id": "CVR-022EAEA41C",
"creation_time": "2021-07-13T12:28:24Z",
"initiated_by": "contact",
"last_updated_time": "2021-07-13T12:33:54Z",
"last_interacted_time ": "2021-07-13T12:33:54Z",
"contact": "CTC-9QEG09XXYN",
"owner": "USR-GNSBE50D6A",
"status": "closed",
"website": "WEB-B1D45D12BB",
"audience": null,
"bot": "BOT-62774A40FB",
"answers": [
{
"id": "INT-5D22DCBE36",
"internal_label": "",
"question": "Full name",
"value": "Carrie Customer"
},
{
"id": "INT-4CC379BB35",
"internal_label": "",
"question": "Email address",
"value": "[email protected] "
},
{
"id": "INT-013A1D5216",
"internal_label": "",
"question": "Meeting location",
"value": "123 Office Street"
}
],
"bookings": ["BKNG-3KM0HY2BF9SL"]
}