MessagingSession

Represents a session on a Messaging channel. This object is available in API version 47.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
AcceptTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time when an agent accepts an incoming Messaging session.
AgentMessageCount	Type int Properties Nillable Description The number of messages sent by the agent during the session.
AgentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of agent that is assigned to the Messaging session. Possible values are: `Agent` `Bot` `BotToAgent`—Bot & Agent `System`—Used for triggered outbound messages
CaseId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case associated with this Messaging session.
ChannelEndUserFormula	Type string Properties Filter, Group, idLookup, Nillable, Sort Description A concatenation of the Messaging channel and Messaging user.
ChannelGroup	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The group of the associated Messaging channel.
ChannelIntent	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The intent of the associated Messaging channel.
ChannelKey	Type string Properties Filter, Group, Nillable, Sort Description The unique identifier for the associated Messaging channel.
ChannelLocale	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The locale of the associated Messaging channel.
ChannelName	Type string Properties Filter, Group, Nillable, Sort Description The name of the associated Messaging channel.
ChannelType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the associated Messaging channel. Possible values are: `Facebook` `Phone` `Text` `WhatsApp`
EndTime	Type dateTime Properties Create, Filter, Nillable, Sort Description The time when the Messaging session ended.
EndUserAccountId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the end user's account record.
EndUserContactId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the end user's contact record.
EndUserMessageCount	Type int Properties Nillable Description The number of messages sent by the Messaging end user.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LeadId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Lead associated with this Messaging session.
MessagingChannelId	Type reference Properties Create, Filter, Group, Sort Description The ID of the Messaging channel associated with this Messaging session.
MessagingEndUserId	Type reference Properties Create, Filter, Group, Sort Description The ID of the Messaging end user associated with this Messaging session.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of this Messaging session.
OpportunityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the opportunity record associated with this Messaging session.
Origin	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The origin of this Messaging session. Possible values are: `AgentInitiated` `ConversationClose` `InboundInitiated` `OptIn`—Opt In Status Change `OptOut`—Opt Out Status Change `TriggeredOutbound`
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner associated with this Messaging session.
PreviewDetails	Type string Properties Nillable Description The preview shown to an agent for this Messaging session.
SessionKey	Type string Properties Create, Filter, Group, Nillable, Sort Description The identifier for the Messaging session.
StartTime	Type dateTime Properties Create, Filter, Nillable, Sort Description The time when the Messaging session started.
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The status of the Messaging session. Possible values are: `Active` `Ended` `New` `Waiting`
TargetUserId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the target user associated with this Messaging session.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

MessagingSessionFeed: Feed tracking is available for the object.
MessagingSessionHistory: History is available for tracked fields of the object.
MessagingSessionOwnerSharingRule: Sharing rules are available for the object.
MessagingSessionShare: Sharing is available for the object.

Object Reference for Salesforce and Lightning Platform

MessagingSession

Supported Calls

Fields

Associated Objects