afv-library/skills/platform-metadata-api-context-get/data/metadata_api/ConversationMessageDefinition.json

380 lines
47 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "ConversationMessageDefinition - Metadata API",
"description": "Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session.",
"file_information": ".conversationMessageDefinition",
"directory_location": "conversationMessageDefinitions",
"fields_columns": [
"type",
"description",
"required"
],
"fields": {
"constants": {
"type": "ConversationMessageConstant[]",
"description": "An array of constants that defines the messaging components. Constants support multiple data types, including text, URL, and image."
},
"contentCategory": {
"type": "ConversationMessageContentCategory (enumeration of type string)",
"description": "Specifies the business intent of the Conversation Message Definition. Valid values are: AccountUpdate Authentication Feedback OrderUpdate PromotionalOutreach Reminder Response"
},
"description": {
"type": "string",
"description": "The description of the conversation message definition."
},
"label": {
"type": "string",
"description": "A user-friendly name for ConversationMessageDefinition, which is defined whenConversationMessageDefinition is created."
},
"language": {
"type": "string",
"description": "The language of the conversation message definition."
},
"messageHandlers": {
"type": "ConversationMessageHandler[]",
"description": "An array of message handlers."
},
"messageLayouts": {
"type": "ConversationMessageLayout[]",
"description": "An array of message layouts."
},
"optionsParameter": {
"type": "ConversationMessageOptionsParameter[]",
"description": "An array of options parameter of the ConversationMessageDefinition."
},
"parameters": {
"type": "ConversationMessageParameter[]",
"description": "An array of parameters."
},
"type": {
"type": "ConversationMessageDefinitionType (enumeration of type string)",
"required": true,
"description": "The type of the conversation message definition. Valid values are: Action ApexForm AuthenticationRequest AutoResponse Link Notification PaymentRequest Picklist RecordPicker RecordView TimePicker"
}
},
"sub_types": {
"ConversationMessageConstant": {
"compositeValues": {
"type": "ConversationMessageConstantCompositeValue[]",
"description": "An array of composite values of ConversationMessageConstant."
},
"constantType": {
"type": "ConversationMessageConstantType (enumeration of type string)",
"required": true,
"description": "The conversation message constant type. Valid values are: Custom Image Options SubTitle Title Url"
},
"label": {
"type": "string",
"description": "The UI label of the conversation message constant."
},
"name": {
"type": "string",
"description": "The name of the conversation message constant."
},
"primitiveValues": {
"type": "ConversationMessageConstantPrimitiveValue (enumeration of type string)",
"description": "An array of primitive values of ConversationMessageConstant."
},
"valueType": {
"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": {
"constantItems": {
"type": "ConversationMessageConstant[]",
"description": "An array of constant items."
},
"identifier": {
"type": "string",
"required": true,
"description": "The client identifier."
}
},
"ConversationMessageConstantPrimitiveValue": {
"contentAssetName": {
"type": "string",
"description": "Represents the value for type = ImageAsset"
},
"textValue": {
"type": "string",
"description": "Represents the value for type = Text"
},
"type": {
"type": "ConversationMessageConstantValueType (enumeration of type string)",
"required": true,
"description": "The type of the conversation message constant primitive value. Valid values are: FileAsset ImageAsset Text Url"
},
"urlValue": {
"type": "string",
"description": "Represents the value for type = Url"
}
},
"ConversationMessageHandler": {
"activeRequestDurationMinutes": {
"type": "int",
"required": true,
"description": "The duration of an active request in minutes."
},
"handlerName": {
"type": "string",
"required": true,
"description": "The name of the message handler."
},
"handlerType": {
"type": "ConversationMessageHandlerType (enumeration of type string)",
"required": true,
"description": "The type of message handler. Valid values are: ApexFormProvider. Available in API version 65.0 and later. AuthProvider PaymentProvider QuickAction Survey. Available in API version 65.0 and later."
}
},
"ConversationMessageLayout": {
"externalTemplates": {
"type": "ConvMsgExternalTemplateVersion[]",
"description": "The external template version of the ConversationMessageLayout."
},
"formatType": {
"type": "ConversationMessageFormatType (enumeration of type string)",
"required": true,
"description": "The format type of the conversation message layout. Valid values are: Application Buttons Carousel EncryptedOAuthToken ExternalTemplate Flow Inputs ListPicker Media Payment QuickReplies RichLink Text TimePicker WebView"
},
"layoutItems": {
"type": "ConversationMessageLayoutItem[]",
"description": "An array of layout items."
},
"messageType": {
"type": "ConversationMessageType (enumeration of type string)",
"required": true,
"description": "The conversation message type. Valid values are: AuthenticationRequest Choices Form PaymentRequest StaticContent"
}
},
"ConvMsgExternalTemplateVersion": {
"accountIdentifier": {
"type": "string",
"required": true,
"description": "The account identifier. For WhatsApp channels, this is the WABA ID."
},
"accountName": {
"type": "string",
"required": true,
"description": "The account name."
},
"language": {
"type": "string",
"required": true,
"description": "The language of the conversation message external template."
},
"status": {
"type": "ConvMsgExternalTemplateVersionStatus (enumeration of type string)",
"required": true,
"description": "The status of the conversation message external template. Valid values are: 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 Metas review process."
},
"templateName": {
"type": "string",
"required": true,
"description": "The name of the conversation message external template."
},
"templateVersionIdentifier": {
"type": "string",
"required": true,
"description": "The template version identifier."
}
},
"ConversationMessageLayoutItem": {
"collectionType": {
"type": "ConversationMessageCollectionType (enumeration of type string)",
"required": true,
"description": "The type of conversation message collection. Valid values are: DynamicList None StaticList"
},
"compositeValues": {
"type": "ConversationMessageLayoutCompositeValue[]",
"description": "An array of composite values of the ConversationMessageLayoutItem."
},
"name": {
"type": "string",
"description": "The name of the conversation message layout item."
},
"primitiveValues": {
"type": "ConversationMessageLayoutPrimitiveValue[]",
"description": "An array of primitive values of the ConversationMessageLayoutItem."
}
},
"ConversationMessageLayoutCompositeValue": {
"compositeTypeName": {
"type": "string",
"required": true,
"description": "The name of the conversation message layout composite value type."
},
"layoutItems": {
"type": "ConversationMessageLayoutItem[]",
"description": "An array of layout items."
},
"valueSourceReference": {
"type": "string",
"description": "The source of the conversation message layout composite value."
}
},
"ConversationMessageLayoutPrimitiveValue": {
"contentAssetName": {
"type": "string",
"description": "The content asset name."
},
"fieldName": {
"type": "string",
"description": "The name of the conversation message layout primitive value field."
},
"formulaTemplate": {
"type": "string",
"description": "The formula template defines the content for each entry in the list."
},
"literalValue": {
"type": "string",
"description": "The literal primitive value of the conversation message layout."
},
"mergeFields": {
"type": "ConversationMessageMergeField[]",
"description": "Inserts multiple values to a list."
},
"type": {
"type": "ConversationMessageLayoutValueType (enumeration of type string)",
"required": true,
"description": "The type of the conversation message layout primitive value. Valid values are: FormulaTemplate Literal MediaAsset SourcePrimitiveValue SourceSobjectField SourceSobjectFieldValue SourceSobjectFormula"
},
"valueFormula": {
"type": "string",
"description": "The formula of the conversation message layout primitive value."
},
"valueSourceReference": {
"type": "string",
"description": "The source of the conversation message layout primitive value."
}
},
"ConversationMessageMergeField": {
"formulaTemplate": {
"type": "string",
"required": true,
"description": "The formula template of the conversation message merge field."
},
"mergeFieldType": {
"type": "ConversationMessageMergeFieldType (enumeration of type string)",
"required": true,
"description": "The type of the conversation message merge field. Valid value is ListTemplate."
},
"name": {
"type": "string",
"required": true,
"description": "The name of the conversation message merge field."
},
"valueSourceReference": {
"type": "string",
"required": true,
"description": "The source of the conversation message merge field value."
}
},
"ConversationMessageOptionsParameter": {
"compositeTypeDetails": {
"type": "ConversationMessageParameterCompositeDetails[]",
"description": "An array of composite details of ConversationMessageOptionsParameter."
},
"optionsParameterType": {
"type": "ConversationMessageOptionsParameterType (enumeration of type string)",
"required": true,
"description": "The type of conversation message options parameter. Valid values are: CustomCompositeOptions CustomPrimitiveOptions RecordIdOptions TimeSlotOptions"
},
"primitiveTypeDetails": {
"type": "ConversationMessageParameterPrimitiveDetails",
"description": "The primitive type details of conversation message options parameter."
}
},
"ConversationMessageParameterCompositeDetails": {
"compositeChildItems": {
"type": "ConversationMessageParameterCompositeDetails[]",
"description": "The composite child items of the conversation message parameter."
},
"isList": {
"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": {
"type": "boolean",
"description": "Indicates whether the conversation message parameter is required (true) or not (false). The default value is false."
},
"label": {
"type": "string",
"description": "The UI label of the conversation message parameter composite details field."
},
"maxListItems": {
"type": "int",
"description": "The maximum number of list items in the conversation message parameter composite details field."
},
"name": {
"type": "string",
"description": "The name of the conversation message parameter composite details field."
},
"primitiveChildItems": {
"type": "ConversationMessageParameterPrimitiveDetails[]",
"description": "An array of primitive child items."
}
},
"ConversationMessageParameterPrimitiveDetails": {
"isList": {
"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": {
"type": "boolean",
"description": "Indicates whether the conversation message parameter primitive details field is required (true) or not (false). The default value is false."
},
"label": {
"type": "string",
"description": "The UI label of the conversation message parameter primitive details field."
},
"maxListItems": {
"type": "int",
"description": "The maximum number of list items that are allowed in the conversation message parameter primitive details field."
},
"name": {
"type": "string",
"description": "The name of the conversation message parameter primitive details field."
},
"sobjectType": {
"type": "string",
"description": "The sObject type."
},
"valueType": {
"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": {
"compositeTypeDetails": {
"type": "ConversationMessageParameterCompositeDetails",
"description": "An array of composite type details."
},
"parameterType": {
"type": "ConversationMessageParameterType (enumeration of type string)",
"required": true,
"description": "The type of conversation message parameter. Valid values are: CustomComposite CustomPrimitive RecordIds"
},
"primitiveTypeDetails": {
"type": "ConversationMessageParameterPrimitiveDetails",
"description": "An array of primitive type details."
}
}
},
"wsdl_segment": "```xml\n<xsd:simpleType name=\"ConvMsgExternalErrorCode\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"InvalidParameter\"/>\n <xsd:enumeration value=\"IntegrityError\"/>\n <xsd:enumeration value=\"InternalError\"/>\n <xsd:enumeration value=\"PublishError\"/>\n <xsd:enumeration value=\"DeprecationError\"/>\n <xsd:enumeration value=\"MetricsThresholdNotReached\"/>\n <xsd:enumeration value=\"InvalidAccessToken\"/>\n <xsd:enumeration value=\"ValidationError\"/>\n <xsd:enumeration value=\"Other\"/>\n <xsd:enumeration value=\"OutOfSync\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ConvMsgExternalRejectionReason\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"AbusiveContent\"/>\n <xsd:enumeration value=\"IncorrectCategory\"/>\n <xsd:enumeration value=\"InvalidFormat\"/>\n <xsd:enumeration value=\"Scam\"/>\n <xsd:enumeration value=\"Other\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"ConvMsgExternalTemplateVersion\">\n <xsd:sequence>\n <xsd:element name=\"accountIdentifier\" type=\"xsd:string\"/>\n <xsd:element name=\"accountName\" type=\"xsd:string\"/>\n <xsd:element name=\"errorCode\" minOccurs=\"0\" type=\"tns:ConvMsgExternalErrorCode\"/>\n <xsd:element name=\"errorMessage\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalConfigJson\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"headerAssetHandle\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"language\" type=\"xsd:string\"/>\n <xsd:element name=\"layoutJson\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"rejectionReason\" minOccurs=\"0\" type=\"tns:ConvMsgExternalRejectionReason\"/>\n <xsd:element name=\"status\" type=\"tns:ConvMsgExternalTemplateVersionStatus\"/>\n <xsd:element name=\"templateName\" type=\"xsd:string\"/>\n <xsd:element name=\"templateVersionIdentifier\" type=\"xsd:string\"/>\n <xsd:element name=\"type\" minOccurs=\"0\" type=\"tns:ConvMsgExternalTemplateVersionType\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ConvMsgExternalTemplateVersionStatus\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Pending\"/>\n <xsd:enumeration value=\"Rejected\"/>\n <xsd:enumeration value=\"Approved\"/>\n <xsd:enumeration value=\"Paused\"/>\n <xsd:enumeration value=\"Disabled\"/>\n <xsd:enumeration value=\"InAppeal\"/>\n <xsd:enumeration value=\"PendingDeletion\"/>\n <xsd:enumeration value=\"Deleted\"/>\n <xsd:enumeration value=\"LimitExceeded\"/>\n <xsd:enumeration value=\"Blocked\"/>\n <xsd:enumeration value=\"OutOfSync\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ConvMsgExternalTemplateVersionType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Legacy\"/>\n <xsd:enumeration value=\"Template\"/>\n <xsd:enumeration value=\"Flow\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ConversationMessageCollectionType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"None\"/>\n <xsd:enumeration value=\"StaticList\"/>\n <xsd:enumeration value=\"DynamicList\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"ConversationMessageConstant\">\n <xsd:sequence>\n <xsd:element name=\"compositeValues\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ConversationMessageConstantCompositeValue\"/>\n <xsd:element name=\"constantType\" type=\"tns:ConversationMessageConstantType\"/>\n <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"name\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"primitiveValues\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ConversationMessageConstantPrimitiveValue\"/>\n <xsd:element name=\"valueType\" minOccurs=\"0\" type=\"tns:ConversationMessageValueType\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ConversationMessageCo
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a ConversationMessageDefinition component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ConversationMessageDefinition xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <constants>\n <constantType>Custom</constantType>\n <label>imageAsset</label>\n <name>imageAsset</name>\n <primitiveValues>\n <contentAssetName>Screenshot_20240402_at_32437PM</contentAssetName>\n <type>ImageAsset</type>\n </primitiveValues>\n <valueType>ImageId</valueType>\n </constants>\n <constants>\n <constantType>Custom</constantType>\n <label>message</label>\n <name>message</name>\n <primitiveValues>\n <textValue>Favourite Season</textValue>\n <type>Text</type>\n </primitiveValues>\n <valueType>Text</valueType>\n </constants>\n <constants>\n <constantType>Custom</constantType>\n <label>Prompt1</label>\n <name>Prompt1</name>\n <primitiveValues>\n <textValue>Choose one option</textValue>\n <type>Text</type>\n </primitiveValues>\n <valueType>Text</valueType>\n </constants>\n <constants>\n <compositeValues>\n <constantItems>\n <constantType>Image</constantType>\n <primitiveValues>\n <contentAssetName>Screenshot_20240321_at_53957PM3</contentAssetName>\n <type>ImageAsset</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>SubTitle</constantType>\n <primitiveValues>\n <textValue>January</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>Title</constantType>\n <primitiveValues>\n <textValue>Jan</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <identifier>1c6f8c4d-7bce-1649-fa45-db587bcfbb29</identifier>\n </compositeValues>\n <compositeValues>\n <constantItems>\n <constantType>Image</constantType>\n <primitiveValues>\n <contentAssetName>Screenshot_20240321_at_53957PM4</contentAssetName>\n <type>ImageAsset</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>SubTitle</constantType>\n <primitiveValues>\n <textValue>December</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>Title</constantType>\n <primitiveValues>\n <textValue>Dec</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <identifier>fb8bb328-7bc7-2830-6194-2ae7ece055ad</identifier>\n </compositeValues>\n <compositeValues>\n <constantItems>\n <constantType>Image</constantType>\n <primitiveValues>\n <contentAssetName>Screenshot_20240321_at_53912PM1</contentAssetName>\n <type>ImageAsset</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>SubTitle</constantType>\n <primitiveValues>\n <textValue>March</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <constantItems>\n <constantType>Title</constantType>\n <primitiveValues>\n <textValue>March</textValue>\n <type>Text</type>\n </primitiveValues>\n </constantItems>\n <identifier>570baa88-fa4d-4b31-0e84-92f87b35af0a</id
}
]
}