afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/MessagingSession.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "MessagingSession - Data API",
  "description": "Represents a session on a Messaging channel. This object is available in API version 47.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AcceptTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update"
    },
    "AgentMessageCount": {
      "type": "int",
      "properties": "Nillable"
    },
    "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"
    },
    "ChannelEndUserFormula": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable, Sort"
    },
    "ChannelKey": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort"
    },
    "ChannelLocale": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update"
    },
    "ChannelName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort"
    },
    "ChannelType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of the associated Messaging channel. Possible values are: Alexa AppleBusinessChat—Represents Apple Messages for Business. EmbeddedMessaging—Available in API version 55.0 and later. Facebook GoogleHome Line Omega Phone Text Voice WeChat WebChat WhatsApp"
    },
    "ConversationId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the related conversation. Available in API version 55.0 and later. This field is a relationship field.",
      "relationship_name": "Conversation",
      "relationship_type": "Lookup",
      "refers_to": "Conversation"
    },
    "EndedByType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort"
    },
    "EndTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort"
    },
    "EndUserAccountId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort"
    },
    "EndUserContactId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort"
    },
    "EndUserLanguage": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update"
    },
    "EndUserMessageCount": {
      "type": "int",
      "properties": "Nillable"
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort"
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort"
    },
    "LeadId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update"
    },
    "MessagingChannelId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort"
    },
    "MessagingEndUserId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort"
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort"
    },
    "OpportunityId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update"
    },
    "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—Messaging user deleted the conversation in Apple Messages ConversationControlLost—Third-party bot resumes control from Salesforce bot or agent Help InboundInitiated OptIn—Opt In Status Change OptOut—Opt Out Status Change TriggeredOutbound Messaging sessions can’t be created using Apex code. They can be created only through customer initiation or by using Process Builder, flows, or the Start Conversation action."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update"
    },
    "PreviewDetails": {
      "type": "string",
      "properties": "Nillable"
    },
    "SessionKey": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort"
    },
    "StartTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort"
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The status of the Messaging session. Possible values are: New (standard channels only) Active Consent (enhanced channels only) Waiting Paused (enhanced channels only) Inactive (enhanced channels only) Ended Error (enhanced channels only) To learn more about these statuses, see Lifecycle of a Messaging Session in Salesforce Help."
    },
    "TargetUserId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the target user associated with this Messaging session. This is a relationship field.",
      "relationship_name": "TargetUser",
      "relationship_type": "Lookup",
      "refers_to": "User"
    }
  },
  "usage": "To monitor messaging session activity, report on the MessagingSession and MessagingSessionMetrics objects. MessagingSessionMetrics captures metrics about a messaging session, such as agent and end user response time. See Report on Messaging Activity in Service Cloud.",
  "associated_objects": "This object has the following associated objects. Unless noted, they’re available in the same API version as this object.\n\n- **MessagingSessionChangeEvent (API version 62.0)**: Change events are available for the object.\n- **MessagingSessionFeed**: Feed tracking is available for the object.\n- **MessagingSessionHistory**: History is available for tracked fields of the object.\n- **MessagingSessionOwnerSharingRule**: Sharing rules are available for the object.\n- **MessagingSessionShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"MessagingSession\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"AcceptTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"AgentMessageCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"AgentType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Case\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Case\"/>\n        <element name=\"CaseId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ChannelEndUserFormula\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelGroup\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelIntent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelLocale\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ChannelType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ConvEntryRelatedRecordCopies\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Conversation\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Conversation\"/>\n        <element name=\"ConversationEntries\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ConversationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EndUserAccount\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"EndUserAccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"EndUserContact\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Contact\"/>\n        <element name=\"EndUserContactId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"EndUserLanguage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"EndUserMessageCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"EndedByType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Lead\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Lead\"/>\n        <element name=\"LeadId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"MessagingChannel\" nillable=\"true\" minOccurs=\"0\" type=\"ens:MessagingChannel\"/>\n        <element name=\"MessagingChannelId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"MessagingEndUser\" nillable=\"true\" minOccurs=\"0\" type=\"ens:MessagingEndUser\"/>\n        <element name=\"MessagingEndUserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"MessagingSessionMetricsAgg\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Opportunity\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Opportunity\"/>\n        <element name=\"OpportunityId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Origin\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PreviewDetails\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SessionKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"StartTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SuspendedByType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TargetUser\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"TargetUserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "AcceptTime": {
      "field_label": "Accept Time",
      "type": "datetime"
    },
    "AgentMessageCount": {
      "field_label": "Agent Message Count",
      "type": "int",
      "digits": "9"
    },
    "AgentType": {
      "field_label": "Agent Type",
      "type": "picklist",
      "length": "255"
    },
    "CampaignId": {
      "field_label": "Campaign ID",
      "type": "reference",
      "length": "18"
    },
    "CaseId": {
      "field_label": "Case ID",
      "type": "reference",
      "length": "18"
    },
    "ChannelEndUserFormula": {
      "field_label": "Concatenated Messaging Channel and Messaging User",
      "type": "string",
      "length": "50"
    },
    "ChannelGroup": {
      "field_label": "Group",
      "type": "string",
      "length": "255"
    },
    "ChannelIntent": {
      "field_label": "Intent",
      "type": "string",
      "length": "255"
    },
    "ChannelKey": {
      "field_label": "Channel Key",
      "type": "string",
      "length": "150"
    },
    "ChannelLocale": {
      "field_label": "Locale",
      "type": "string",
      "length": "255"
    },
    "ChannelName": {
      "field_label": "Channel Name",
      "type": "string",
      "length": "80"
    },
    "ChannelType": {
      "field_label": "Channel Type",
      "type": "picklist",
      "length": "255"
    },
    "ConversationId": {
      "field_label": "Conversation ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "EndTime": {
      "field_label": "End Time",
      "type": "datetime"
    },
    "EndUserAccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "EndUserContactId": {
      "field_label": "Contact ID",
      "type": "reference",
      "length": "18"
    },
    "EndUserLanguage": {
      "field_label": "Messaging User Language",
      "type": "picklist",
      "length": "255"
    },
    "EndUserMessageCount": {
      "field_label": "End User Message Count",
      "type": "int",
      "digits": "9"
    },
    "EndedByType": {
      "field_label": "Ended By Type",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Messaging Session ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Issue__c": {
      "field_label": "Issue",
      "type": "textarea",
      "length": "32768"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LeadId": {
      "field_label": "Lead ID",
      "type": "reference",
      "length": "18"
    },
    "MessagingChannelId": {
      "field_label": "Messaging Channel ID",
      "type": "reference",
      "length": "18"
    },
    "MessagingEndUserId": {
      "field_label": "Messaging User ID",
      "type": "reference",
      "length": "18"
    },
    "Name": {
      "field_label": "Messaging Session Name",
      "type": "string",
      "length": "255"
    },
    "OpportunityId": {
      "field_label": "Opportunity ID",
      "type": "reference",
      "length": "18"
    },
    "Origin": {
      "field_label": "Origin",
      "type": "picklist",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PreviewDetails": {
      "field_label": "Preview Details",
      "type": "string",
      "length": "255"
    },
    "Resolution__c": {
      "field_label": "Resolution",
      "type": "textarea",
      "length": "32768"
    },
    "SessionKey": {
      "field_label": "Session Key",
      "type": "string",
      "length": "36"
    },
    "StartTime": {
      "field_label": "Start Time",
      "type": "datetime"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "Summary__c": {
      "field_label": "Summary",
      "type": "textarea",
      "length": "32768"
    },
    "SuspendedByType": {
      "field_label": "Suspended By Type",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TargetUserId": {
      "field_label": "User ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "digits",
    "length"
  ]
}