| 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
|
| ClientDuration |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The length in milliseconds for the entry. This field is used with
voice messages and other applicable use cases. This value may be 0
if not set by the client. This field is available in API version
51.0 and later.
|
| ClientTimestamp |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort
- Description
- The timestamp sent by the client when it generated the entry. This
field is available in API version 51.0 and later.
|
| ConversationId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The MessagingSession ID this entry belongs to.
|
| EntryEndTime |
- Type
- datetime
- Properties
- Create, Filter, Nillable, Sort
- Description
- The timestamp that this entry ended in the chat history. This
field is available in API version 48.0 and later.
|
| EntryTime |
- Type
- datetime
- Properties
- Create, Filter, Sort
- Description
- The timestamp of this entry in the chat history.
|
| EntryTimeMilliSecs |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The milliseconds value for the time when an entry was received by
the server. Note that the related EntryTime
field does not provide millisecond accuracy. This field is
available in API version 51.0 and later.
|
| 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
-
ChatbotEndedChatByAction—Conversation
ended by automated action
-
ChatbotEndedTransferNotConfigured—Conversation
ended because transfer fail is not configured
- 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.
|
|
MessageIdentifier
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort
|
| 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:
- Delivered
- Error
- Pending
- Read
- Sent
|
| MessageStatusCode |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The code associated with a message status.
MessageStatusCode is only populated when a
message is undeliverable
|
| Seq |
- Type
- int
- Properties
- Create, Filter, Group, Sort
- Description
- The sequence position of this entry in the chat history.
|
| ServerReceivedTimestamp |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort
- Description
- The timestamp recorded when the server received the entry. This is
a unique value and is used for ordering. This value can also be
referred to as the “transcripted timestamp.” This field is
available in API version 51.0 and later.
|