MessagingChannel

Represents a communication channel that an end user can use to send a message to an agent. A communication channel can be an SMS number, a Facebook page, or another supported messaging channel. This object is available in API version 45.0 and later.

Supported Calls

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

Fields

Field Name	Details
BusinessHoursId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The operating hours for your business, when agents are available. Available only in orgs that use Einstein Bots.
ConsentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of consent, or opt-in, that is required to message users on this channel. This field is available in API version 48.0 and later. Possible values are: `DoubleOptIn` `ExplicitOptIn` `ImplicitOptIn` (default value)
ConversationEndResponse	Type textarea Properties Create, Nillable, Update Description Automated response to the customer when the agent ends the conversation. (Optional)
CriticalWaitTime	Description Reserved for future use.
Description	Description Reserved for future use.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The developer name for the messaging channel. This value is a concatenation of the messaging platform key and the message type.
DoubleOptInPrompt	Type textarea Properties Create, Nillable, Update Description Automated response to the end user to prompt them to doubly opt in to receiving messages.
EngagedResponse	Type textarea Properties Create, Nillable, Update Description Automated response to the customer when the conversation is accepted by the agent. (Optional)
InitialResponse	Type textarea Properties Create, Nillable, Update Description First automated response to the customer for a new conversation. (Optional)
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a channel is active and can receive messages.
IsAuthenticated	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a user is authenticated to a voice assistant.
IsLinkedRecordOpenedAsSubTab	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to show the contact as a subtab.
IsoCountryCode	Type string Properties Create, Filter, Group, Nillable, Sort Description Two-letter ISO 3166-1 alpha-2 code for the country that the phone number is associated with. For example, the code for United States is `US`.
IsRequireDoubleOptIn	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether double opt-in is required (`true`) or not (`false`) for this Messaging channel.
IsRestrictedToBusinessHours	Description Reserved for future use.
IsUserMatchByExternalIdOnly	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to restrict matching on customer by external ID only (and not use the full name).
Language	Description Reserved for future use.
LinkingPreference	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Preference for linking a new user that sends a message using this channel. Currently supports contact linking.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Unique name for the `MessagingChannel`.
MessageType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of message. Possible values are: `Facebook` `Phone` `Text` `WhatsApp`
MessagingPlatformKey	Type string Properties Create, Filter, Group, Sort, Update Description Unique key for a channel that the end user can message.
OfflineAgentsResponse	Description Reserved for future use.
OptInPrompt	Type textarea Properties Create, Nillable, Update Description Automated response to the end user to prompt them to explicitly opt in to receiving messages.
OptInResponse	Type textarea Properties Create, Defaulted on create, Nillable, Update Description Automated response to the end user when they opt in to messaging. Maximum API version 48.0
OptOutResponse	Type textarea Properties Create, Defaulted on create, Nillable, Update Description Automated response to the end user when they opt out of messaging. Maximum API version 48.0
OutsideBusinessHoursResponse	Description Reserved for future use.
RoutingConfigurationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies which Omni-Channel routing configuration to use. This field is required when `RoutingType` is `OmniSkills`. To learn more, see Create Routing Configurations.
RoutingType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type used to support Omni-Channel’s different routing methods. `OmniQueue` (queue-based routing) `OmniSkills` (skills-based routing) When this value isn’t set, `OmniQueue` is used.
TargetQueueId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Queue in which incoming conversations are placed while waiting for an agent to accept.
TargetUserId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Messaging User or agent for the conversation.

Object Reference for Salesforce and Lightning Platform

MessagingChannel

Supported Calls

Fields