Newer Version Available

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

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
Description
Reserved for future use.
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.
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.

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).

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.

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
  • Text
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.
OptInResponse
Type
textarea
Properties
Create, Defaulted on create, Nillable, Update
Description

Automated response to the end user when they opt in to messaging.

OptOutResponse
Type
textarea
Properties
Create, Defaulted on create, Nillable, Update
Description

Automated response to the end user when they opt out of messaging.

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.