Conversations are the core objects in Drift. They represent a series of Messages exchanged between a single Contact and a group of Participants. Participants are generally employees of the organization or a Bot. Each Conversation has a time-ordered set of Messages representing chat messages, internal notes, and metadata events within that communication
Messages make up the meat of a Conversation. They will contain information regarding the text sent and metadata on the sender.
All Conversation and Message interactions are based at https://driftapi.com/conversations and have the following response conventions:
{
"id": int,
"orgId": int,
"participants": [int],
"status": string (one of {open, closed, pending}),
"contactId": int,
"inboxId": int,
"createdAt": timestamp,
"conversationTags": [
{
color: string (hex value),
name: string
},
]
}id
Conversations are uniquely identified by an id, which can be used to check its current state and its messages.
participants
Each Conversation has a set of participants; Drift Users who are taking part in, or responsible for communication with the Contact. This field is a set of ids that uniquely identify each User.
status
Conversations in Drift are organized by their status: open Conversations are active and should be responded to, pending ones are waiting on follow up, and closed are handled and not actively being communicated with. Conversations may move in between any of these statuses as Users change them or new events cause them (e.g. if a Contact sends a new message in a closed Conversation, its status will be changed to open).
contactId
The id of the Contact that's being communicated with in this Conversation.
createdAt
A Unix timestamp representing the moment that the conversation was created.
orgId
The Drift organization this Conversation belongs to.
inboxId
The inbox this conversation belongs to, can reconstruct drift conversation links via:
https://app.drift.com/inboxes/{inboxId}/conversations/{conversationId}
conversationTags
Any tags applied to the conversation, include their color appearance in the conversation view within drift.