MessagingChannel

Represents the metadata associated with an Embedded Service Messaging channel.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

This type extends Metadata and inherits its fields.

MessagingChannel components have the suffix messagingChannel and are stored in the messagingChannels folder.

Introduced in API version 55.0.

This type is available if your org has the “Configure Messaging” and “View Setup and Configuration” permissions for Messaging enabled.

  • Type: MessagingAutoResponse[]
  • Required: No
  • Description: The auto-responses associated with the messaging channel.
  • Type: MessagingChannelUsage[]
  • Required: No
  • Introduced: API version 62.0
  • Description: The deployment types and consent configuration for the messaging channel.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The ISO country code for the messaging channel.
  • Type: string
  • Required: No
  • Description: The channel description.
  • Type: int
  • Required: No
  • Type: EndUserIdleAction (enumeration of type string)
  • Required: No
  • Type: int
  • Required: No
  • Introduced: API version 66.0
  • Description: The number of minutes of end-user inactivity until the conversation is automatically marked inactive. Valid values are from 5 through 30.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The external account identifier for the messaging channel.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: string
  • Required: Yes
  • Description: Required. The channel label.

  • Type: MessagingChannelType (enumeration of type string)

  • Required: Yes

  • Introduced: API version 65.0

  • Description: Required. Values are:

    Third-party Messaging channels in Salesforce, such as WhatsApp and Facebook Messenger, don’t use this metadata type.

  • Possible values:

    • AppleMessagesForBusiness — Apple Messages for Business. Available in API version 65.0 and later.
    • Custom — Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS. Available in API version 61.0 and later.
    • EmbeddedMessaging — Enhanced Chat.
    • Facebook — Facebook Messenger. Available in API version 65.0 and later.
    • Line — Line. Available in API version 65.0 and later.
    • PstnVoice — Agentforce Voice (PSTN). Available in API version 65.0 and later.
    • Text — SMS. Available in API version 65.0 and later.
    • SipVoice — Represents an Agentforce Voice channel that uses SIP. Available in API version 65.0 and later.
    • Voice — Service Cloud Voice. Available in API version 58.0 and later.
    • WhatsApp — WhatsApp. Available in API version 65.0 and later.
    • WhatsAppVoice — Available in API version 65.0 and later.
  • Type: MessagingKeyword[]
  • Required: No
  • Description: Keywords associated with the messaging channel.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The platform key for the messaging channel.
  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: The queue routing configuration for the messaging channel.
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: The Omni-Channel flow used to route the channel’s messaging sessions.
  • Type: string
  • Required: No
  • Description: Required. The queue used to route messages. If a sessionHandlerFlow is also selected, sessionHandlerQueue is the fallback queue used if a message can’t be routed using the selected flow.
  • Type: MessagingSessionHandlerType (enumeration of type string)
  • Required: Yes
  • Description: Required. The method used to route messages in the channel. Values are:
  • Possible values:
    • AgentforceServiceAgent
    • Flow
    • Queue
    • User
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The user to handle routing for the messaging channel.

Represents settings specific to an embedded messaging channel.

  • Type: Integer
  • Required: No
  • Description: If authMode is set to false, this value represents the JWT expiry value in minutes.

  • Type: EmbeddedServiceAuthModeType

  • Required: Yes

  • Description: Required. Auth/UnAuth Mode Types For Embedded Chat. Valid values are:

    • Auth
    • UnAuth
  • Type: Boolean
  • Required: No
  • Description: Indicates whether inbound file attachments are allowed. The default value is false.
  • Type: Boolean
  • Required: No
  • Description: Indicates whether estimated wait time is enabled. The default value is false.
  • Type: Boolean
  • Required: No
  • Description: Indicates whether transcripts can be downloaded. The default value is false.
  • Type: MessagingAuthorization
  • Required: No
  • Description: Represents authorization settings specific to a given MessagingChannel.
  • Type: Integer
  • Required: No
  • Description: If authMode is set to true, this value represents the JWT expiry value in minutes.
  • Type: string
  • Required: No
  • Type: int
  • Required: No
  • Type: EmbeddedServiceAuthModeType
  • Required: Yes
  • Type: int
  • Required: No
  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: int
  • Required: No
  • Type: string
  • Required: No
  • Type: EmbeddedMsgQueueLimitType
  • Required: No
  • Type: int
  • Required: No
  • Type: int
  • Required: No

This junction entity stores the messaging channel authorization for a Messaging Channel (Embedded Messaging Channel). On this entity, we configure different authorization methods supported by the Messaging for In-App and Web `(Embedded Messaging) channel. This entity is available in API version 62.0 or later.

  • Type: string
  • Required: Yes
  • Description: Required. Represents an identifier for the MessagingAuthorization entity. The value must begin with a letter. Only alphanumeric characters and _ are allowed.
  • Type: MessagingAuthorizationType (enumeration of type string)
  • Required: Yes
  • Description: Required. Indicates whether MessagingAuthorization has been configured to reference a PublicKeyCertificateSet or an AuthProvider.
  • Possible values:
    • PublicKeyCertificateSet — Indicates that a PublicKeyCertificateSet is referenced in the MessagingAuthorization entity. This is the only option that will lead to a fully functional User Verification setup.
    • AuthProvider — This option should never be selected. It indicates that an AuthProvider is referenced in the MessagingAuthorization, but we don’t support it.
  • Type: string
  • Required: No
  • Description: This field should never be set. Although this field is exposed, it isn’t supported. The field represents the name of the AuthProvider that’s referenced in the MessagingAuthorization. It’s a required field if authorizationType is set to AuthProvider.
  • Type: boolean
  • Required: No
  • Description: Indicates whether messaging authorization is enabled. Defaults to false.
  • Type: string
  • Required: No
  • Description: Name of the public key certificate set that’s referenced in the MessagingAuthorization entity. This is a required field if authorizationType is set to PublicKeyCertificateSet.

Represents an automated response used in a channel.

  • Type: AutoResponseContentType (enumeration of type string)
  • Required: Yes
  • Description: The content type of the auto-response: TextResponse or MessageDefinition.
  • Type: string
  • Required: No
  • Description: The language of the auto response.
  • Type: string
  • Required: No
  • Description: The name of the messaging component.
  • Type: string
  • Required: No
  • Description: The text of the auto response.
  • Type: int
  • Required: No
  • Description: The number of minutes after which a response can no longer be sent. The value can range from 5 to 60.
  • Type: MessagingAutoResponseType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of response, which determines when it’s used in a messaging session. Values are:
  • Possible values:
    • AgentEndEngagementResponse
    • AgentEngagedResponse
    • CustomResponse — (Available in API version 65.0 and later.)
    • DoubleOptInPrompt — (Available in API version 65.0 and later.)
    • EndUserIdleResponse — (Available in API version 65.0 and later.)
    • EndUserInactiveResponse — (Available in API version 65.0 and later.)
    • HelpResponse — (Available in API version 65.0 and later.)
    • InitialResponse
    • OptInConfirmation — (Available in API version 65.0 and later.)
    • OptInPrompt — (Available in API version 65.0 and later.)
    • OptOutConfirmation — (Available in API version 65.0 and later.)
    • RerouteResponse — (Available in API version 68.0 and later.)

Represents a mapping between a parameter and an Omni-Channel flow or agent task.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the flow that the custom or standard parameters are mapped to.

Represent a custom parameter added to a channel.

  • Type: string
  • Required: Yes
  • Description: Required. The external name of the parameter.
  • Type: string
  • Required: Yes
  • Description: Required. The label of the parameter.
  • Type: int
  • Required: No
  • Description: The maximum length of the parameter value.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the parameter.
  • Type: FlowDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. The format of the parameter. Values are:
  • Possible values:
    • Apex
    • Boolean
    • Currency
    • Date
    • DateTime
    • Multipicklist
    • Number
    • Picklist
    • SObject
    • String
    • Time

Represents a standard parameter used to pass information into a channel.

  • Type: MessagingChannelStandardParameterType (enumeration of type string)
  • Required: No
  • Description: An ID assigned to the external interaction, such as a campaign ID.
  • Possible values:
    • FirstName
    • LastName
    • Email
    • Subject
  • Type: MessagingChannelStandardParameterType (enumeration of type string)
  • Required: No
  • Description: The name of the external interaction, such as a campaign name.
  • Possible values:
    • FirstName
    • LastName
    • Email
    • Subject
  • Type: MessagingChannelStandardParameterType (enumeration of type string)
  • Required: No
  • Description: The type of external interaction, such as MarketingCampaign.
  • Possible values:
    • FirstName
    • LastName
    • Email
    • Subject
  • Type: MessagingChannelStandardParameterType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of parameter. Values are:
  • Possible values:
    • Email
    • FirstName
    • LastName
    • Subject

Represents the deployment type and consent configuration for a messaging channel.

Introduced in API version 62.0.

  • Type: MessagingChannelConsentType (enumeration of type string)
  • Required: No
  • Description: Optional. The consent type for the messaging channel. Values are:
  • Possible values:
    • ImplicitOptIn
    • ExplicitOptIn
    • DoubleOptIn
  • Type: MessagingChannelUsageDeploymentType (enumeration of type string)
  • Required: Yes
  • Description: Required. The deployment type for the messaging channel. Values are:
  • Possible values:
    • DigitalEngagementConversation
    • UnifiedConversation
    • MessagingEngagement
    • MarketingJourneyBuilder

Represents settings specific to an EmbeddedMessaging MessagingChannel.

Introduced in API version 62.0.

  • Type: string[]
  • Required: No
  • Description: The messaging keyword value.

  • Type: MessagingKeywordType (enumeration of type string)

  • Required: Yes

  • Description: Required. The type of messaging keyword for the auto response. Valid values are:

    • OptIn
    • DoubleOptIn
    • OptOut
    • Help
    • Custom
  • Type: string
  • Required: Yes
  • Description: Required. The language of the messaging keyword

The following is an example of a MessagingChannel component. This messaging channel passes custom and standard parameters from the messaging channel to a flow, and it routes to a flow with a fallback queue.

If you route the messaging channel to a queue, there’s no fallback flow.

The following is an example package.xml that references the previous definition.

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.