| 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.
- This is a relationship field.
- Relationship Name
- BusinessHours
- Relationship Type
- Lookup
- Refers To
- BusinessHours
|
| ChannelAddressIdentifier |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- A UUID that identifies a deployed messaging channel.
This identifier is unique across orgs, so a channel with
the same MessagingPlatformKey in a sandbox and
production will have a
different ChannelAddressIdentifier for each. Available
in API version 59.0 and later.
|
| ChannelDefinitionId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The associated conversation channel definition, which is used only in Bring Your Own
Channel for Messaging and Bring Your Own Channel for
CCaaS. Available in API version 58.0 and later.
- This field is a relationship field.
- Relationship Name
- ChannelDefinition
- Refers To
- ConversationChannelDefinition
|
| ConsentType |
- Type
- picklist
- Properties
- Create, defaultedOnCreate, 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)
The property defaultedOnCreate has been removed in API
version 51.0 and later. Now the consent type is
defaulted to ImplicitOptIn when the consent type isn’t
set on create only for channels that support
consents.
|
| 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. This field has been deprecated
as of API version 52.0.
|
| 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. Available in API
version 48.0 and later.
|
| 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. The org permission
Live Message Voice is required to access and update this
field. Available in API version 44.0 and later.
|
| 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. Available in API
version 44.0 and later.
|
| 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. Available in API version 48.0
and later.
|
| 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). This field has been deprecated as of API
version 52.0.
|
| Language |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable,
Restricted picklist, Sort, Update
- Description
- Reserved for future use.
|
| MasterLabel |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, 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:
-
AppleBusinessChat—Represents Apple
Messages for Business.
-
Custom—Represents Bring Your Own Channel for
Messaging or Bring Your Own Channel for CCaaS.
Available in API version 58.0 and later.
-
EmbeddedMessaging—Represents Enhanced Chat.
Available in API version 50.0 and later.
- Facebook
- Phone
-
PSTNVoice—Represents an Agentforce Voice
channel that uses PSTN. Available in API version
65.0 and later.
- Text
- Voice
- WhatsApp
|
| MessagingPlatformKey |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- Unique key for a channel that the end user can message or call based on the
MessageType.
- In PSTNVoice, SMS, WhatsApp, and LINE channels,
the platform key is the phone number associated
with this channel.
- In Facebook Messenger channels, the platform key
is the Facebook page ID associated with this
channel.
- In Apple Messages for Business channels, the
platform key is the Apple Messages
identifier.
- In Enhanced Chat, the platform key is identical to the Channel Address
Identifier.
|
| 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. Available
in API version 49.0 and earlier.
|
| OptInResponse |
- Type
- textarea
- Properties
- Create, Defaulted on create, Nillable, Update
- Description
-
Automated response to the end user when they opt in
to messaging. Available in API versions 48.0 and
49.0. Use the OptInConfirmation
field of the MsgChannelLanguageKeyword object
instead.
|
| OptionsIdentifyEndUserLanguage |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Auto-populates the Language field for this channel’s messaging users if their locale
is known. Supported for Enhanced Chat and Apple Messages
for Business only.
|
| OptOutResponse |
- Type
- textarea
- Properties
- Create, Defaulted on create, Nillable, Update
- Description
-
Automated response to the end user when they opt out
of messaging. Available in API version 48.0 only.
Use the OptOutConfirmation
field of the MsgChannelLanguageKeyword
object instead.
|
| OutsideBusinessHoursResponse |
- Description
- Reserved for future use.
|
| PlatformType |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort
- Description
- Indicates whether the channel is Standard or
Enhanced.
When a standard SMS or Facebook Messenger channel
is upgraded, the PlatformType changes from Standard to Enhanced. When a
standard WhatsApp channel is upgraded, the original
channel’s PlatformType remains Standard and a new
channel is created with a PlatformType of Enhanced.
Enhanced Chat channels
have a PlatformType of Enhanced.
|
| 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.
|
| SessionHandler |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort, Update
- Description
- The queue or Omni-Channel flow that the channel's
messaging sessions are routed to. Available in API
version 51.0 and later.
|
| 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.
- This is a relationship field.
- Relationship Name
- TargetQueue
- Relationship Type
- Lookup
- Refers To
- Group
|
|
TargetUserId
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Messaging User or agent for the conversation. Available
in API version 50.0 and earlier.
|
j