ConversationMessageDefinition

Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session.

This type extends Metadata and inherits its fields.

ConversationMessageDefinition components have the suffix .conversationMessageDefinition and are stored in the conversationMessageDefinitions folder.

ConversationMessageDefinition is supported for use in enhanced Messaging channels and Messaging for In-App and Web, and is available in API version 59.0 and later.

• Type: ConversationMessageConstant[]
• Required: No
• Description: An array of constants that defines the messaging components. Constants support multiple data types, including text, URL, and image.

• Type: ConversationMessageContentCategory (enumeration of type string)
• Required: No
• Description: Specifies the business intent of the Conversation Message Definition.
• Possible values:
  • AccountUpdate
  • Authentication
  • Feedback
  • OrderUpdate
  • PromotionalOutreach
  • Reminder
  • Response

• Type: string
• Required: No
• Description: The description of the conversation message definition.

• Type: string
• Required: Yes
• Description: A user-friendly name for ConversationMessageDefinition, which is defined whenConversationMessageDefinition is created.

• Type: string
• Required: No
• Description: The language of the conversation message definition.

• Type: ConversationMessageHandler[]
• Required: No
• Description: An array of message handlers.

• Type: ConversationMessageLayout[]
• Required: No
• Description: An array of message layouts.

• Type: ConversationMessageOptionsParameter
• Required: No
• Description: An array of options parameter of the ConversationMessageDefinition.

• Type: ConversationMessageParameter[]
• Required: No
• Description: An array of parameters.

• Type: ConversationMessageDefinitionType (enumeration of type string)
• Required: Yes
• Description: Required. The type of the conversation message definition.
• Possible values:
  • Action
  • ApexForm
  • AuthenticationRequest
  • AutoResponse
  • GuidedActions — Available in API version 68.0 and later.
  • Link
  • Notification
  • PaymentRequest
  • Picklist
  • RecordPicker
  • RecordView
  • TimePicker

Represents a constant value on the messaging component. When a messaging component is created in the UI, the text and images entered during creation are saved as standard constants. Custom constants can also be added.

• Type: ConversationMessageConstantCompositeValue[]
• Required: No
• Description: An array of composite values of ConversationMessageConstant.

• Type: ConversationMessageConstantType (enumeration of type string)
• Required: Yes
• Description: Required. The conversation message constant type.
• Possible values:
  • Custom
  • Image
  • Options
  • SubTitle
  • Title
  • Url

• Type: string
• Required: No
• Description: The UI label of the conversation message constant.

• Type: string
• Required: No
• Description: The name of the conversation message constant.

• Type: ConversationMessageConstantPrimitiveValue[]
• Required: No
• Description: An array of primitive values of ConversationMessageConstant.

• Type: ConversationMessageValueType (enumeration of type string)
• Required: No
• Description: The type of the conversation message constant value.
• Possible values:
  • Boolean
  • Date
  • DateTime
  • Double
  • ImageId
  • Integer
  • RecordId
  • Text
  • Url
  • VideoId — Available in API version 68.0 and later.

Represents the composite values of the ConversationMessageConstant.

• Type: ConversationMessageConstant[]
• Required: No
• Description: An array of constant items.

• Type: string
• Required: Yes
• Description: Required. The client identifier.

Represents the primitive values of the ConversationMessageConstant.

• Type: string
• Required: No
• Description: Represents the value for type = ImageAsset

• Type: string
• Required: No
• Description: Represents the value for type = Text

• Type: ConversationMessageConstantValueType (enumeration of type string)
• Required: Yes
• Description: Required. The type of the conversation message constant primitive value.
• Possible values:
  • FileAsset
  • ImageAsset
  • Text
  • Url

• Type: string
• Required: No
• Description: Represents the value for type = Url

Represents the conversation message handler.

• Type: int
• Required: Yes
• Description: Required. The duration of an active request in minutes.

• Type: string
• Required: Yes
• Description: Required. The name of the message handler.

• Type: ConversationMessageHandlerType (enumeration of type string)
• Required: Yes
• Introduced: API version 65.0
• Description: Required. The type of message handler.
• Possible values:
  • ApexFormProvider — . Available in API version 65.0 and later.
  • AuthProvider
  • PaymentProvider
  • QuickAction
  • Survey — . Available in API version 65.0 and later.

Represents the conversation message layout.

• Type: ConvMsgExternalTemplateVersion[]
• Required: No
• Description: The external template version of the ConversationMessageLayout.

• Type: ConversationMessageFormatType (enumeration of type string)
• Required: Yes
• Description: Required. The format type of the conversation message layout.
• Possible values:
  • Application
  • BusinessUpdate — Available in API version 68.0 and later.
  • Buttons
  • Carousel
  • EncryptedOAuthToken
  • ExternalTemplate
  • Flow
  • Inputs
  • ListPicker
  • Media
  • Payment
  • QuickReplies
  • RichLink
  • Suggestions — Available in API version 68.0 and later.
  • Text
  • TimePicker
  • WebView

• Type: ConversationMessageLayoutItem[]
• Required: No
• Description: An array of layout items.

• Type: ConversationMessageLayoutVariant (enumeration of type string)
• Required: Yes

• Type: ConversationMessageType (enumeration of type string)
• Required: Yes
• Description: Required. The conversation message type.
• Possible values:
  • AuthenticationRequest
  • Choices
  • Form
  • PaymentRequest
  • StaticContent

Represents the composite value of the ConversationMessageLayoutItem.

• Type: string
• Required: Yes
• Description: Required. The name of the conversation message layout composite value type.

• Type: ConversationMessageLayoutItem[]
• Required: No
• Description: An array of layout items.

• Type: string
• Required: No
• Description: The source of the conversation message layout composite value.

Represents the conversation message layout item.

• Type: ConversationMessageCollectionType (enumeration of type string)
• Required: Yes
• Description: Required. The type of conversation message collection.
• Possible values:
  • DynamicList
  • None
  • StaticList

• Type: ConversationMessageLayoutCompositeValue[]
• Required: No
• Description: An array of composite values of the ConversationMessageLayoutItem.

• Type: string
• Required: Yes
• Description: The name of the conversation message layout item.

• Type: ConversationMessageLayoutPrimitiveValue[]
• Required: No
• Description: An array of primitive values of the ConversationMessageLayoutItem.

Represents the primitive value of the ConversationMessageLayoutItem.

• Type: string
• Required: No
• Description: The content asset name.

• Type: string
• Required: No
• Description: The name of the conversation message layout primitive value field.

• Type: string
• Required: No
• Description: The formula template defines the content for each entry in the list.

• Type: string
• Required: No
• Description: The literal primitive value of the conversation message layout.

• Type: string
• Required: No

• Type: ConversationMessageMergeField[]
• Required: No
• Description: Inserts multiple values to a list.

• Type: ConversationMessageLayoutValueType (enumeration of type string)
• Required: Yes
• Description: Required. The type of the conversation message layout primitive value.
• Possible values:
  • FormulaTemplate
  • Literal
  • MediaAsset
  • SourcePrimitiveValue
  • SourceSobjectField
  • SourceSobjectFieldValue
  • SourceSobjectFormula

• Type: string
• Required: No
• Description: The formula of the conversation message layout primitive value.

• Type: string
• Required: No
• Description: The source of the conversation message layout primitive value.

Merge field is used to insert multiple values to a list.

• Type: string
• Required: Yes
• Description: Required. The formula template of the conversation message merge field.

• Type: ConversationMessageMergeFieldType (enumeration of type string)
• Required: Yes
• Description: Required. The type of the conversation message merge field. Valid value is ListTemplate.

• Type: string
• Required: Yes
• Description: Required. The name of the conversation message merge field.

• Type: string
• Required: Yes
• Description: Required. The source of the conversation message merge field value.

Represents a conversation message options parameter.

• Type: ConversationMessageParameterCompositeDetails
• Required: No
• Description: An array of composite details of ConversationMessageOptionsParameter.

• Type: ConversationMessageOptionsParameterType (enumeration of type string)
• Required: Yes
• Description: Required. The type of conversation message options parameter.
• Possible values:
  • CustomCompositeOptions
  • CustomPrimitiveOptions
  • RecordIdOptions
  • TimeSlotOptions

• Type: ConversationMessageParameterPrimitiveDetails
• Required: No
• Description: The primitive type details of conversation message options parameter.

Represents a conversation message parameter.

• Type: ConversationMessageParameterCompositeDetails
• Required: No
• Description: An array of composite type details.

• Type: ConversationMessageParameterType (enumeration of type string)
• Required: Yes
• Description: Required. The type of conversation message parameter.
• Possible values:
  • CustomComposite
  • CustomPrimitive
  • RecordIds

• Type: ConversationMessageParameterPrimitiveDetails
• Required: No
• Description: An array of primitive type details.

Represents the composite details of a conversation message parameter.

• Type: ConversationMessageParameterCompositeDetails[]
• Required: No
• Description: The composite child items of the conversation message parameter.

• Type: boolean
• Required: No
• Description: Indicates whether the conversation message parameter composite details field is a list item (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether the conversation message parameter is required (true) or not (false). The default value is false.

• Type: string
• Required: No
• Description: The UI label of the conversation message parameter composite details field.

• Type: int
• Required: No
• Description: The maximum number of list items in the conversation message parameter composite details field.

• Type: string
• Required: No
• Description: The name of the conversation message parameter composite details field.

• Type: ConversationMessageParameterPrimitiveDetails[]
• Required: No
• Description: An array of primitive child items.

Represents the primitive details of the conversation message parameter.

• Type: boolean
• Required: No
• Description: Indicates whether the conversation message parameter primitive details field is a list item (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether the conversation message parameter primitive details field is required (true) or not (false). The default value is false.

• Type: string
• Required: No
• Description: The UI label of the conversation message parameter primitive details field.

• Type: int
• Required: No
• Description: The maximum number of list items that are allowed in the conversation message parameter primitive details field.

• Type: string
• Required: No
• Description: The name of the conversation message parameter primitive details field.

• Type: string
• Required: No
• Description: The sObject type.

• Type: ConversationMessageValueType (enumeration of type string)
• Required: No
• Description: The type of the conversation message parameter value.
• Possible values:
  • Boolean
  • Date
  • DateTime
  • Double
  • ImageId
  • Integer
  • RecordId
  • Text
  • Url
  • VideoId — Available in API version 68.0 and later.

Represents the external template version of the conversation message layout.

• Type: string
• Required: Yes
• Description: Required. The account identifier. For WhatsApp channels, this is the WABA ID.

• Type: string
• Required: Yes
• Description: Required. The account name.

• Type: ConvMsgExternalErrorCode (enumeration of type string)
• Required: No

• Type: string
• Required: No

• Type: string
• Required: No

• Type: string
• Required: No

• Type: string
• Required: Yes
• Description: Required. The language of the conversation message external template.

• Type: string
• Required: No

• Type: ConvMsgExternalRejectionReason (enumeration of type string)
• Required: No

• Type: ConvMsgExternalTemplateVersionStatus (enumeration of type string)
• Required: Yes
• Introduced: API version 65.0
• Description: Required. The status of the conversation message external template.
• Possible values:
  • Approved — . The template version is approved.
  • Blocked — . The template version is blocked. Available in API version 65.0 and later.
  • Deleted — . The template version is deleted. Available in API version 65.0 and later.
  • Disabled — . The template version is disabled because of recurring negative customer feedback.
  • InAppeal — . The rejected template version is being appealed. Available in API version 65.0 and later.
  • LimitExceeded — . Available in API version 65.0 and later.
  • OutOfSync — . The template versions in the messaging service and Salesforce are out of sync. Available in API version 65.0 and later.
  • Paused — . The template version is paused because of recurring negative customer feedback or low read rates.
  • Pending — . The template version awaits Meta’s approval.
  • PendingDeletion — . The template version is pending deletion. Available in API version 65.0 and later.
  • Rejected — . The template version was rejected during Meta’s review process.

• Type: string
• Required: Yes
• Description: Required. The name of the conversation message external template.

• Type: string
• Required: Yes
• Description: Required. The template version identifier.

• Type: ConvMsgExternalTemplateVersionType (enumeration of type string)
• Required: No

The following is an example of a ConversationMessageDefinition component.

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.