Newer Version Available

This content describes an older version of this product. View Latest

ConversationEntry

Represents a message or an event in the chat history between an agent and a messaging user. This object is available in API version 43.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field Details
ActorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the author. The possible values can be null or any ID in the following domain set:
  • BotDefinition
  • LiveChatVisitor
  • MessagingEndUser
  • User
ActorName
Type
string
Properties
Create, Filter, Nillable, Sort
Description
The name of the author sending the message or event.
ActorType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The author of this entry in the chat history. The valid values include:
  • Agent
  • Bot
  • EndUser
  • Supervisor
  • System
ConversationId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The MessagingSession ID this entry belongs to.
EntryTime
Type
datetime
Properties
Create, Filter, Sort
Description
The timestamp of this entry in the chat history.
EntryType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The type of entry in the chat history. Can be a message (text) or an event. The possible values include:
  • Text
  • AdminOptedIn
  • AdminOptedOut
  • BotEscalated
  • ChatbotClosedIdleSession
  • ChatbotEstablished
  • ChatbotNotEstablished
  • EndUserOptedIn
  • EndUserOptedOut
HasAttachments
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Indicates whether a message has attachments associated with it (true) or not (false).
Message
Type
textarea
Properties
Create, Nillable
Description
The message or event sent by the author.
MessageDeliverTime
Type
datetime
Properties
Create, Filter, Nillable, Sort
Description
Unused field reserved for future use.
MessageReadTime
Type
datetime
Properties
Create, Filter, Nillable, Sort
Description
Unused field reserved for future use.
MessageSendTime
Type
datetime
Properties
Create, Filter, Nillable, Sort
Description
Unused field reserved for future use.
MessageStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the message sent by the author. The valid values include:
  • Error
  • Delivered
  • Pending
  • Read
  • Sent
MessageStatusCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
The code associated with a message status.
Seq
Type
int
Properties
Create, Filter, Group, Sort
Description
The sequence position of this entry in the chat history.