ConversationMessageDefinition | Metadata API Developer Guide

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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

Version

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.

Fields

Field Name	Description
constants	Field Type ConversationMessageConstant[] Description An array of constants that defines the messaging components. Constants support multiple data types, including text, URL, and image.
description	Field Type string Description The description of the conversation message definition.
label	Field Type string Description A user-friendly name for ConversationMessageDefinition, which is defined whenConversationMessageDefinition is created.
language	Field Type string Description The language of the conversation message definition.
messageHandlers	Field Type ConversationMessageHandler[] Description An array of message handlers.
messageLayouts	Field Type ConversationMessageLayout[] Description An array of message layouts.
optionsParameter	Field Type ConversationMessageOptionsParameter[] Description An array of options parameter of the ConversationMessageDefinition.
parameters	Field Type ConversationMessageParameter[] Description An array of parameters.
type	Field Type ConversationMessageDefinitionType (enumeration of type string) Description Required. The type of the conversation message definition. Valid values are: `Action` `AuthenticationRequest` `AutoResponse` `Link` `Notification` `PaymentRequest` `Picklist` `RecordPicker` `RecordView` `TimePicker`

ConversationMessageConstant

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.

Field Name	Description
compositeValues	Field Type ConversationMessageConstantCompositeValue[] Description An array of composite values of ConversationMessageConstant.
constantType	Field Type ConversationMessageConstantType (enumeration of type string) Description Required. The conversation message constant type. Valid values are: `Custom` `Image` `Options` `SubTitle` `Title` `Url`
label	Field Type string Description The UI label of the conversation message constant.
name	Field Type string Description The name of the conversation message constant.
primitiveValues	Field Type ConversationMessageConstantPrimitiveValue (enumeration of type string) Description An array of primitive values of ConversationMessageConstant.
valueType	Field Type ConversationMessageValueType (enumeration of type string) Description The type of the conversation message constant value. Valid values are: `Boolean` `Date` `DateTime` `Double` `ImageId` `Integer` `RecordId` `Text` `Url`

ConversationMessageConstantCompositeValue

Represents the composite values of the ConversationMessageConstant.

Field Name	Description
constantItems	Field Type ConversationMessageConstant[] Description An array of constant items.
identifier	Field Type string Description Required. The client identifier.

ConversationMessageConstantPrimitiveValue

Represents the primitive values of the ConversationMessageConstant.

Field Name	Description
contentAssetName	Field Type string Description Represents the value for type = ImageAsset
textValue	Field Type string Description Represents the value for type = Text
type	Field Type ConversationMessageConstantValueType (enumeration of type string) Description Required. The type of the conversation message constant primitive value. Valid values are: `ImageAsset` `Text` `Url`
urlValue	Field Type string Description Represents the value for type = Url

ConversationMessageHandler

Represents the conversation message handler.

Field Name	Description
activeRequestDurationMinutes	Field Type int Description Required. The duration of an active request in minutes.
handlerName	Field Type string Description Required. The name of the message handler.
handlerType	Field Type ConversationMessageHandlerType (enumeration of type string) Description Required. The type of message handler. Valid values are: `AuthProvider` `PaymentProvider` `QuickAction`

ConversationMessageLayout

Represents the conversation message layout.

Field Name	Description
externalTemplates	Field Type ConvMsgExternalTemplateVersion[] Description The external template version of the ConversationMessageLayout.
formatType	Field Type ConversationMessageFormatType (enumeration of type string) Description Required. The format type of the conversation message layout. Valid values are: `Application` `Buttons` `Carousel` `EncryptedOAuthToken` `ExternalTemplate` `Inputs` `ListPicker` `Media` `Payment` `QuickReplies` `RichLink` `Text` `TimePicker` `WebView`
layoutItems	Field Type ConversationMessageLayoutItem[] Description An array of layout items.
messageType	Field Type ConversationMessageType (enumeration of type string) Description Required. The conversation message type. Valid values are: `AuthenticationRequest` `Choices` `Form` `PaymentRequest` `StaticContent`

ConvMsgExternalTemplateVersion

Represents the external template version of the conversation message layout.

Field Name	Description
accountIdentifier	Field Type string Description Required. The account identifier. For WhatsApp channels, this is the WABA ID.
accountName	Field Type string Description Required. The account name.
language	Field Type string Description Required. The language of the conversation message external template.
status	Field Type ConvMsgExternalTemplateVersionStatus (enumeration of type string) Description Required. The status of the conversation message external template. Valid values are: `Approved` `Disabled` `InAppeal` `Paused` `Pending` `Rejected`
templateName	Field Type string Description Required. The name of the conversation message external template.
templateVersionIdentifier	Field Type string Description Required. The template version identifier.

ConversationMessageLayoutItem

Represents the conversation message layout item.

Field Name	Description
collectionType	Field Type ConversationMessageCollectionType (enumeration of type string) Description Required. The type of conversation message collection. Valid values are: `DynamicList` `None` `StaticList`
compositeValues	Field Type ConversationMessageLayoutCompositeValue[] Description An array of composite values of the ConversationMessageLayoutItem.
name	Field Type string Description The name of the conversation message layout item.
primitiveValues	Field Type ConversationMessageLayoutPrimitiveValue[] Description An array of primitive values of the ConversationMessageLayoutItem.

ConversationMessageLayoutCompositeValue

Represents the composite value of the ConversationMessageLayoutItem.

Field Name	Description
compositeTypeName	Field Type string Description Required. The name of the conversation message layout composite value type.
layoutItems	Field Type ConversationMessageLayoutItem[] Description An array of layout items.
valueSourceReference	Field Type string Description The source of the conversation message layout composite value.

ConversationMessageLayoutPrimitiveValue

Represents the primitive value of the ConversationMessageLayoutItem.

Field Name	Description
contentAssetName	Field Type string Description The content asset name.
fieldName	Field Type string Description The name of the conversation message layout primitive value field.
formulaTemplate	Field Type string Description The formula template defines the content for each entry in the list.
literalValue	Field Type string Description The literal primitive value of the conversation message layout.
mergeFields	Field Type ConversationMessageMergeField[] Description Inserts multiple values to a list.
type	Field Type ConversationMessageLayoutValueType (enumeration of type string) Description Required. The type of the conversation message layout primitive value. Valid values are: `FormulaTemplate` `Literal` `MediaAsset` `SourcePrimitiveValue` `SourceSobjectField` `SourceSobjectFieldValue` `SourceSobjectFormula`
valueFormula	Field Type string Description The formula of the conversation message layout primitive value.
valueSourceReference	Field Type string Description The source of the conversation message layout primitive value.

ConversationMessageMergeField

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

Field Name	Description
formulaTemplate	Field Type string Description Required. The formula template of the conversation message merge field.
mergeFieldType	Field Type ConversationMessageMergeFieldType (enumeration of type string) Description Required. The type of the conversation message merge field. Valid value is ListTemplate.
name	Field Type string Description Required. The name of the conversation message merge field.
valueSourceReference	Field Type string Description Required. The source of the conversation message merge field value.

ConversationMessageOptionsParameter

Represents a conversation message options parameter.

Field Name	Description
compositeTypeDetails	Field Type ConversationMessageParameterCompositeDetails[] Description An array of composite details of ConversationMessageOptionsParameter.
optionsParameterType	Field Type ConversationMessageOptionsParameterType (enumeration of type string) Description Required. The type of conversation message options parameter. Valid values are: `CustomCompositeOptions` `CustomPrimitiveOptions` `RecordIdOptions` `TimeSlotOptions`
primitiveTypeDetails	Field Type ConversationMessageParameterPrimitiveDetails Description The primitive type details of conversation message options parameter.

ConversationMessageParameterCompositeDetails

Represents the composite details of a conversation message parameter.

Field Name	Description
compositeChildItems	Field Type ConversationMessageParameterCompositeDetails[] Description The composite child items of the conversation message parameter.
isList	Field Type boolean Description Indicates whether the conversation message parameter composite details field is a list item (`true`) or not (`false`). The default value is false.
isRequired	Field Type boolean Description Indicates whether the conversation message parameter is required (`true`) or not (`false`). The default value is false.
label	Field Type string Description The UI label of the conversation message parameter composite details field.
maxListItems	Field Type int Description The maximum number of list items in the conversation message parameter composite details field.
name	Field Type string Description The name of the conversation message parameter composite details field.
primitiveChildItems	Field Type ConversationMessageParameterPrimitiveDetails[] Description An array of primitive child items.

ConversationMessageParameterPrimitiveDetails

Represents the primitive details of the conversation message parameter.

Field Name	Description
isList	Field Type boolean Description Indicates whether the conversation message parameter primitive details field is a list item (`true`) or not (`false`). The default value is false.
isRequired	Field Type boolean Description Indicates whether the conversation message parameter primitive details field is required (`true`) or not (`false`). The default value is false.
label	Field Type string Description The UI label of the conversation message parameter primitive details field.
maxListItems	Field Type int Description The maximum number of list items that are allowed in the conversation message parameter primitive details field.
name	Field Type string Description The name of the conversation message parameter primitive details field.
sobjectType	Field Type string Description The sObject type.
valueType	Field Type ConversationMessageValueType (enumeration of type string) Description The type of the conversation message parameter value. Valid values are: `Boolean` `Date` `DateTime` `Double` `ImageId` `Integer` `RecordId` `Text` `Url`

ConversationMessageParameter

Represents a conversation message parameter.

Field Name	Description
compositeTypeDetails	Field Type ConversationMessageParameterCompositeDetails Description An array of composite type details.
parameterType	Field Type ConversationMessageParameterType (enumeration of type string) Description Required. The type of conversation message parameter. Valid values are: `CustomComposite` `CustomPrimitive` `RecordIds`
primitiveTypeDetails	Field Type ConversationMessageParameterPrimitiveDetails Description An array of primitive type details.

Declarative Metadata Sample Definition

The following is an example of a ConversationMessageDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ConversationMessageDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <constants>
4        <constantType>Custom</constantType>
5        <label>imageAsset</label>
6        <name>imageAsset</name>
7        <primitiveValues>
8            <contentAssetName>Screenshot_20240402_at_32437PM</contentAssetName>
9            <type>ImageAsset</type>
10        </primitiveValues>
11        <valueType>ImageId</valueType>
12    </constants>
13    <constants>
14        <constantType>Custom</constantType>
15        <label>message</label>
16        <name>message</name>
17        <primitiveValues>
18            <textValue>Favourite Season</textValue>
19            <type>Text</type>
20        </primitiveValues>
21        <valueType>Text</valueType>
22    </constants>
23    <constants>
24        <constantType>Custom</constantType>
25        <label>Prompt1</label>
26        <name>Prompt1</name>
27        <primitiveValues>
28            <textValue>Choose one option</textValue>
29            <type>Text</type>
30        </primitiveValues>
31        <valueType>Text</valueType>
32    </constants>
33    <constants>
34        <compositeValues>
35            <constantItems>
36                <constantType>Image</constantType>
37                <primitiveValues>
38                    <contentAssetName>Screenshot_20240321_at_53957PM3</contentAssetName>
39                    <type>ImageAsset</type>
40                </primitiveValues>
41            </constantItems>
42            <constantItems>
43                <constantType>SubTitle</constantType>
44                <primitiveValues>
45                    <textValue>January</textValue>
46                    <type>Text</type>
47                </primitiveValues>
48            </constantItems>
49            <constantItems>
50                <constantType>Title</constantType>
51                <primitiveValues>
52                    <textValue>Jan</textValue>
53                    <type>Text</type>
54                </primitiveValues>
55            </constantItems>
56            <identifier>1c6f8c4d-7bce-1649-fa45-db587bcfbb29</identifier>
57        </compositeValues>
58        <compositeValues>
59            <constantItems>
60                <constantType>Image</constantType>
61                <primitiveValues>
62                    <contentAssetName>Screenshot_20240321_at_53957PM4</contentAssetName>
63                    <type>ImageAsset</type>
64                </primitiveValues>
65            </constantItems>
66            <constantItems>
67                <constantType>SubTitle</constantType>
68                <primitiveValues>
69                    <textValue>December</textValue>
70                    <type>Text</type>
71                </primitiveValues>
72            </constantItems>
73            <constantItems>
74                <constantType>Title</constantType>
75                <primitiveValues>
76                    <textValue>Dec</textValue>
77                    <type>Text</type>
78                </primitiveValues>
79            </constantItems>
80            <identifier>fb8bb328-7bc7-2830-6194-2ae7ece055ad</identifier>
81        </compositeValues>
82        <compositeValues>
83            <constantItems>
84                <constantType>Image</constantType>
85                <primitiveValues>
86                    <contentAssetName>Screenshot_20240321_at_53912PM1</contentAssetName>
87                    <type>ImageAsset</type>
88                </primitiveValues>
89            </constantItems>
90            <constantItems>
91                <constantType>SubTitle</constantType>
92                <primitiveValues>
93                    <textValue>March</textValue>
94                    <type>Text</type>
95                </primitiveValues>
96            </constantItems>
97            <constantItems>
98                <constantType>Title</constantType>
99                <primitiveValues>
100                    <textValue>March</textValue>
101                    <type>Text</type>
102                </primitiveValues>
103            </constantItems>
104            <identifier>570baa88-fa4d-4b31-0e84-92f87b35af0a</identifier>
105        </compositeValues>
106        <constantType>Options</constantType>
107    </constants>
108    <constants>
109        <constantType>Title</constantType>
110        <primitiveValues>
111            <textValue>What is your favourite month?</textValue>
112            <type>Text</type>
113        </primitiveValues>
114    </constants>
115    <label>Favourite Month</label>
116    <language>en_US</language>
117    <messageLayouts>
118        <formatType>Buttons</formatType>
119        <layoutItems>
120            <collectionType>DynamicList</collectionType>
121            <compositeValues>
122                <compositeTypeName>TitleOptionItem</compositeTypeName>
123                <layoutItems>
124                    <collectionType>None</collectionType>
125                    <compositeValues>
126                        <compositeTypeName>TitleItem</compositeTypeName>
127                        <layoutItems>
128                            <collectionType>None</collectionType>
129                            <name>title</name>
130                            <primitiveValues>
131                                <type>SourcePrimitiveValue</type>
132                                <valueSourceReference>Constants.Options.ListItem.SubTitle</valueSourceReference>
133                            </primitiveValues>
134                        </layoutItems>
135                    </compositeValues>
136                    <name>titleItem</name>
137                </layoutItems>
138                <valueSourceReference>Constants.Options</valueSourceReference>
139            </compositeValues>
140            <name>optionItems</name>
141        </layoutItems>
142        <layoutItems>
143            <collectionType>None</collectionType>
144            <name>text</name>
145            <primitiveValues>
146                <type>SourcePrimitiveValue</type>
147                <valueSourceReference>Constants.Title</valueSourceReference>
148            </primitiveValues>
149        </layoutItems>
150        <messageType>Choices</messageType>
151    </messageLayouts>
152    <messageLayouts>
153        <formatType>ListPicker</formatType>
154        <layoutItems>
155            <collectionType>None</collectionType>
156            <compositeValues>
157                <compositeTypeName>TitleImageItem</compositeTypeName>
158                <layoutItems>
159                    <collectionType>None</collectionType>
160                    <name>imageId</name>
161                    <primitiveValues>
162                        <type>SourcePrimitiveValue</type>
163                        <valueSourceReference>Constants.imageAsset</valueSourceReference>
164                    </primitiveValues>
165                </layoutItems>
166                <layoutItems>
167                    <collectionType>None</collectionType>
168                    <name>title</name>
169                    <primitiveValues>
170                        <type>SourcePrimitiveValue</type>
171                        <valueSourceReference>Constants.Title</valueSourceReference>
172                    </primitiveValues>
173                </layoutItems>
174            </compositeValues>
175            <name>message</name>
176        </layoutItems>
177        <layoutItems>
178            <collectionType>DynamicList</collectionType>
179            <compositeValues>
180                <compositeTypeName>TitleOptionItem</compositeTypeName>
181                <layoutItems>
182                    <collectionType>None</collectionType>
183                    <compositeValues>
184                        <compositeTypeName>TitleImageItem</compositeTypeName>
185                        <layoutItems>
186                            <collectionType>None</collectionType>
187                            <name>imageId</name>
188                            <primitiveValues>
189                                <type>SourcePrimitiveValue</type>
190                                <valueSourceReference>Constants.Options.ListItem.Image</valueSourceReference>
191                            </primitiveValues>
192                        </layoutItems>
193                        <layoutItems>
194                            <collectionType>None</collectionType>
195                            <name>title</name>
196                            <primitiveValues>
197                                <type>SourcePrimitiveValue</type>
198                                <valueSourceReference>Constants.Options.ListItem.Title</valueSourceReference>
199                            </primitiveValues>
200                        </layoutItems>
201                    </compositeValues>
202                    <name>titleItem</name>
203                </layoutItems>
204                <valueSourceReference>Constants.Options</valueSourceReference>
205            </compositeValues>
206            <name>optionItems</name>
207        </layoutItems>
208        <layoutItems>
209            <collectionType>None</collectionType>
210            <compositeValues>
211                <compositeTypeName>TitleImageItem</compositeTypeName>
212                <layoutItems>
213                    <collectionType>None</collectionType>
214                    <name>imageId</name>
215                    <primitiveValues>
216                        <type>SourcePrimitiveValue</type>
217                        <valueSourceReference>Constants.imageAsset</valueSourceReference>
218                    </primitiveValues>
219                </layoutItems>
220                <layoutItems>
221                    <collectionType>None</collectionType>
222                    <name>title</name>
223                    <primitiveValues>
224                        <type>SourcePrimitiveValue</type>
225                        <valueSourceReference>Constants.message</valueSourceReference>
226                    </primitiveValues>
227                </layoutItems>
228            </compositeValues>
229            <name>reply</name>
230        </layoutItems>
231        <layoutItems>
232            <collectionType>None</collectionType>
233            <name>title</name>
234            <primitiveValues>
235                <type>SourcePrimitiveValue</type>
236                <valueSourceReference>Constants.Title</valueSourceReference>
237            </primitiveValues>
238        </layoutItems>
239        <messageType>Choices</messageType>
240    </messageLayouts>
241    <messageLayouts>
242        <formatType>Carousel</formatType>
243        <layoutItems>
244            <collectionType>DynamicList</collectionType>
245            <compositeValues>
246                <compositeTypeName>TitleItemWithInteractions</compositeTypeName>
247                <layoutItems>
248                    <collectionType>StaticList</collectionType>
249                    <compositeValues>
250                        <compositeTypeName>TitleOptionItem</compositeTypeName>
251                        <layoutItems>
252                            <collectionType>None</collectionType>
253                            <compositeValues>
254                                <compositeTypeName>TitleItem</compositeTypeName>
255                                <layoutItems>
256                                    <collectionType>None</collectionType>
257                                    <name>title</name>
258                                    <primitiveValues>
259                                        <literalValue>Select One</literalValue>
260                                        <type>Literal</type>
261                                    </primitiveValues>
262                                </layoutItems>
263                            </compositeValues>
264                            <name>titleItem</name>
265                        </layoutItems>
266                    </compositeValues>
267                    <name>interactionItems</name>
268                </layoutItems>
269                <layoutItems>
270                    <collectionType>None</collectionType>
271                    <compositeValues>
272                        <compositeTypeName>TitleImageItem</compositeTypeName>
273                        <layoutItems>
274                            <collectionType>None</collectionType>
275                            <name>imageId</name>
276                            <primitiveValues>
277                                <type>SourcePrimitiveValue</type>
278                                <valueSourceReference>Constants.Options.ListItem.Image</valueSourceReference>
279                            </primitiveValues>
280                        </layoutItems>
281                        <layoutItems>
282                            <collectionType>None</collectionType>
283                            <name>subTitle</name>
284                            <primitiveValues>
285                                <type>SourcePrimitiveValue</type>
286                                <valueSourceReference>Constants.Options.ListItem.SubTitle</valueSourceReference>
287                            </primitiveValues>
288                        </layoutItems>
289                        <layoutItems>
290                            <collectionType>None</collectionType>
291                            <name>title</name>
292                            <primitiveValues>
293                                <type>SourcePrimitiveValue</type>
294                                <valueSourceReference>Constants.Title</valueSourceReference>
295                            </primitiveValues>
296                        </layoutItems>
297                    </compositeValues>
298                    <name>titleItem</name>
299                </layoutItems>
300                <valueSourceReference>Constants.Options</valueSourceReference>
301            </compositeValues>
302            <name>items</name>
303        </layoutItems>
304        <messageType>Choices</messageType>
305    </messageLayouts>
306    <messageLayouts>
307        <formatType>Text</formatType>
308        <layoutItems>
309            <collectionType>None</collectionType>
310            <name>text</name>
311            <primitiveValues>
312                <formulaTemplate>{!$Constants.Title}
313{!$Constants.Prompt1}:
314{!$ListTemplates.OptionsList}</formulaTemplate>
315                <mergeFields>
316                    <formulaTemplate>{!$ListItem.Index}. {!$ListItem.Value.Title}{!BR()}</formulaTemplate>
317                    <mergeFieldType>ListTemplate</mergeFieldType>
318                    <name>OptionsList</name>
319                    <valueSourceReference>Constants.Options</valueSourceReference>
320                </mergeFields>
321                <type>FormulaTemplate</type>
322            </primitiveValues>
323        </layoutItems>
324        <messageType>StaticContent</messageType>
325    </messageLayouts>
326    <type>Picklist</type>
327</ConversationMessageDefinition>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Favourite_Month</members>
5        <name>ConversationMessageDefinition</name>
6    </types>
7    <version>61.0</version>
8</Package>

Wildcard Support in the Manifest File

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.