Conversation entity.
Conversation consists of parts (ConversationPart objects).
{
"id": 1882298,
"created": 1436614153,
"user": {
...
},
"read": true,
"replied": true,
"clicked": false,
"unsubscribed": false,
"closed": false,
"message": 299,
"type": "email",
"reply_type": "text",
"part_last": {
...
},
"parts_count": 5,
"assignee": {
...
},
"unread_parts_count": 0,
"last_admin": {
...
},
"last_update": 1436626215,
"tags": ["sales", "en"]
}
id
Contains conversation ID.
created
date of conversation creation (unix timestamp).
user
— User, with whom this conversation is being conducted.
read
Shows if the first message of the conversation is read (always true
for conversations started by user).
replied
Shows if a user replied in the conversation.
clicked
Shows if a user clicked on any link in the first message of the conversation.
unsubsribed
Shows if the user has unsubscribed from emails having received this conversation as email.
closed
Shows if the conversation is closed.
message
Contains ID of the message, which a user replied and thus started a conversation.
type
— conversation type. Can be of these values: email, popup_small, popup_big, popup_chat
reply_type
— Type of response to a conversation. Can have value: text, email, phone, no
part_last
— Last conversation part ConversationPart object
parts_count
Shows conversation parts quantity
assignee
Administrator, assigned to the conversation. Admin object (can be null
- unassigned).
unread_parts_count
Contains quantity of unread (by the visitor to the site/user) conversation parts (0 - the whole conversation is read, more than 0 - there are unread parts)
last_admin
Last administrator, who participated in the conversation. Admin object (can be null
).
last_update
Contains date of last update in the conversation (date of last part creation). Can be used for sorting conversations.
tags
Contains conversation tags.
From visitor’s (user’s) point of view parts_count
and part_last
can differ from admins (visitor can’t see notes, tags and changes in conversation assignment).
Visitor also can not see such conversation properties as: assignee
, tags
, user
, closed
,
clicked
, unsubscribed
, read
, closed
.