Hinzufügen von benutzerdefinierten Messaging-Komponenten zu einem Drittanbieter-Messaging-Kanal

Einsatzmöglichkeiten für benutzerdefinierte Messaging-Komponenten

Verwenden Sie benutzerdefinierte Messaging-Komponenten, wenn Sie Kunden über ältere Salesforce-Chat-Bereitstellungen oder Drittanbieter-Messaging-Kanäle wie WhatsApp, Apple Messages for Business, Facebook Messenger oder LINE bereitstellen und der Agent umfangreiche interaktive Komponenten zurückgeben soll.

Die anpassbare Messaging-Oberfläche behält die vorkonfigurierten Messaging-Antwortformate (MessagingChoices, MessagingChoicesWithImages, MessagingRichLink und MessagingTimePicker) bei und ermöglicht es Ihnen, neue Komponenten hinzuzufügen.

Hinweis Verwenden Sie stattdessen Benutzerdefinierte Lightning-Typen, wenn Sie eine erweiterte Chat-Version 2 (ECv2) erstellen. Wenn Sie einen vollständig externen Webclient erstellen, verwenden Sie Benutzerdefinierte Verbindungen.

Voraussetzungen

• Messaging-Kanal für Service Cloud: Konfigurieren Sie den entsprechenden Service Cloud-Messaging-Kanal für den veralteten Chat oder Ihren Drittanbieterkanal, bevor Sie die anpassbare Messaging-Verbindung einrichten.
• Metadaten-API-Version: Verwenden Sie Version 66.0 oder höher zum Abrufen und Bereitstellen.
• Vorhandener Agent: Ein Agentforce Agent, der die dateibasierte Messaging-Verbindung (SurfaceAction__Messaging) verwendet.
• Messaging-Komponente: Eine bereitgestellte Messaging-Komponente (z. B. ein Formular), deren ID oder Entwicklername Sie im Antwortformat referenzieren können.

Funktionsweise

Die standardmäßige Messaging-Oberfläche wird als dateibasierte Oberfläche (SurfaceAction__Messaging) mit vier vorkonfigurierten Antwortformaten bereitgestellt. Wenn Sie eine Messaging-Komponente hinzufügen möchten, ersetzen Sie die dateibasierte Oberfläche durch eine anpassbare AiSurface, die auf dieselben vier Antwortformate und Ihr neues benutzerdefiniertes Format verweist.

Nach der Bereitstellung verwendet der Agent die vorkonfigurierten Antwortformate für Auswahlmöglichkeiten, Rich-Links und Zeitauswahlen und wählt Ihr benutzerdefiniertes Format aus, wenn seine Beschreibung und Anweisungen mit der Anforderung des Kunden übereinstimmen.

Wichtig Entfernen oder bearbeiten Sie nicht die vier vorkonfigurierten Antwortformate, die in der Definition der anpassbaren Oberfläche aufgeführt sind. Sie können neue Antwortformate hinzufügen, die vorhandenen jedoch nicht ändern.

Einrichten von benutzerdefinierten Messaging-Komponenten

Organisieren Sie Ihre Metadatendateien mit dieser Struktur und führen Sie dann die folgenden Schritte aus.

metadataToDeploy/
├── package.xml
├── aiResponseFormats/
│   └── Messaging_Form_Messaging_Component.aiResponseFormat
├── aiSurfaces/
│   └── {CustomMessagingSurface}.aiSurface
└── genAiPlannerBundles/
    └── {YourAgentDevName}.genAiPlannerBundle

Schritt 1: Abrufen des GenAiPlanner-Pakets des Agenten

Rufen Sie die GenAiPlannerBundle Ihres Agenten über die Metadaten-API ab. Verwenden Sie diese package.xml für den Abruf.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>GenAiPlannerBundle</name>
    </types>
    <version>66.0</version>
</Package>

Der Abruf gibt die GenAiPlannerBundle für Ihren Agenten zurück.

metadataToDeploy/
└── genAiPlannerBundles/
    └── {YourAgentDevName}.genAiPlannerBundle

Schritt 2: Ersetzen der dateibasierten Messaging-Oberfläche

Suchen Sie in Ihrer GenAiPlannerBundle nach dem plannerSurfaces-Eintrag, dessen surface SurfaceAction__Messaging lautet. Ändern Sie surface zu einem eindeutigen Entwicklernamen für Ihre anpassbare Messaging-Oberfläche (z. B. CustomMessagingSurface). Lassen Sie surfaceType auf Messaging festgelegt.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPlannerBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <!-- Other agent configuration -->

    <plannerSurfaces>
        <adaptiveResponseAllowed>true</adaptiveResponseAllowed>
        <callRecordingAllowed>false</callRecordingAllowed>
        <surface>CustomMessagingSurface</surface>
        <surfaceType>Messaging</surfaceType>
    </plannerSurfaces>
</GenAiPlannerBundle>

Durch diese Änderung wird die dateibasierte Messaging-Oberfläche entfernt und stattdessen Ihre anpassbare Messaging-Oberfläche angehängt.

Schritt 3: Erstellen der anpassbaren Messaging-Oberfläche

Erstellen Sie einen aiSurfaces in Ihrem Bereitstellungspaket. Erstellen Sie darin eine Datei mit dem Namen {the_unique_dev_name_from_step_2}.aiSurface. Der Entwicklername der Datei muss mit dem in Schritt 2 festgelegten surface übereinstimmen.

Die anpassbare Oberfläche muss alle vier vorkonfigurierten Messaging-Antwortformate enthalten, damit das standardmäßige Messaging-Verhalten weiterhin funktioniert.

<?xml version="1.0" encoding="UTF-8"?>
<AiSurface xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>Customizable Messaging connection</description>
    <instructions>
        <instruction>Do not use any of the SURFACE_ACTION__* response formats when none of the instructions below are met.</instruction>
        <sortOrder>1</sortOrder>
    </instructions>
    <instructions>
        <instruction>Do not use the below instructions when the response contains more than 10 choices.</instruction>
        <sortOrder>2</sortOrder>
    </instructions>
    <instructions>
        <instruction>Do not use any of the SURFACE_ACTION__Messaging* type formatting when the response contains only a single, text-only choice and does not include images or URLs.</instruction>
        <sortOrder>3</sortOrder>
    </instructions>
    <masterLabel>Messaging</masterLabel>
    <responseFormats>
        <enabled>true</enabled>
        <responseFormat>SurfaceAction__MessagingChoices</responseFormat>
    </responseFormats>
    <responseFormats>
        <enabled>true</enabled>
        <responseFormat>SurfaceAction__MessagingChoicesWithImages</responseFormat>
    </responseFormats>
    <responseFormats>
        <enabled>true</enabled>
        <responseFormat>SurfaceAction__MessagingRichLink</responseFormat>
    </responseFormats>
    <responseFormats>
        <enabled>true</enabled>
        <responseFormat>SurfaceAction__MessagingTimePicker</responseFormat>
    </responseFormats>
    <source>SurfaceAction__Messaging</source>
    <surfaceType>Messaging</surfaceType>
</AiSurface>

Fügen Sie für jede benutzerdefinierte Messaging-Komponente, die der Agent verwenden soll, einen responseFormats-Eintrag hinzu, der auf den Entwicklernamen Ihrer benutzerdefinierten AiResponseFormat verweist.

<responseFormats>
    <enabled>true</enabled>
    <responseFormat>Messaging_Form_Messaging_Component</responseFormat>
</responseFormats>

Schritt 4: Erstellen des benutzerdefinierten AiResponseFormats

Erstellen Sie einen aiResponseFormats. Erstellen Sie darin eine Datei mit dem Namen {FormatDevName}.aiResponseFormat für jede benutzerdefinierte Messaging-Komponente.

In diesem Beispiel wird eine Messaging-Komponente für Formulare definiert. Das Feld input verweist anhand des Entwicklernamens (oder der ID) mithilfe des MessageDefinition auf eine bereitgestellte Messaging-Komponente. Legen Sie "input_strategy" auf "use_template" fest, damit der Agent die Vorlage ausfüllt, statt eine JSON-Rohdatei zu generieren.

<?xml version="1.0" encoding="UTF-8"?>
<AiResponseFormat xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>A response action. Use this when the user wants to create a case. The user is presented with rich UI.</description>
    <input>{"template":{"messageType":"FormMessage","id":"{{ uuid4() }}","form":{"formatType":"MessageDefinition","messageDefinitionNameOrId":"Create_Case_Form"}},"input_strategy":"use_template"}</input>
    <instructions>
        <instruction>Always use this response format to create a case.</instruction>
        <sortOrder>1</sortOrder>
    </instructions>
    <masterLabel>Messaging Form Messaging Component</masterLabel>
</AiResponseFormat>

Formularvorlagenschema

Verwenden Sie dieses Vorlagenschema für Formular-Messaging-Komponenten. Das Feld input im AiResponseFormat muss eine einzeilige, JSON-codierte Zeichenfolge sein. Die erweiterte Version wird hier nur zur besseren Lesbarkeit angezeigt.

{
  "template": {
    "messageType": "FormMessage",
    "id": "{{ uuid4() }}",
    "form": {
      "formatType": "MessageDefinition",
      "messageDefinitionNameOrId": "Create_Case_Form"
    }
  },
  "input_strategy": "use_template"
}

Schritt 5: Erstellen der Datei package.xml

Erstellen Sie im Stamm Ihres Bereitstellungspakets eine package.xml, die alle drei Metadatentypen deklariert.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>AiResponseFormat</name>
    </types>
    <types>
        <members>*</members>
        <name>AiSurface</name>
    </types>
    <types>
        <members>*</members>
        <name>GenAiPlannerBundle</name>
    </types>
    <version>66.0</version>
</Package>

Schritt 6: Bereitstellen

Stellen Sie die Metadaten mit Salesforce CLI bereit.

sf project deploy start --manifest metadataToDeploy/package.xml

Sie können die Bereitstellung auch mit Ihrem bevorzugten Metadaten-API-Tool vornehmen. Wenn Sie die Bereitstellung inkrementell vornehmen, stellen Sie AiResponseFormat vor AiSurface bereit, da die Oberfläche auf die Antwortformate verweist.

Siehe auch

• Messaging-Komponententypen und -Formate
• Erweiterter Web-Chat
• Einrichten einer benutzerdefinierten Verbindung
• Beispiele für Antwortformate für benutzerdefinierte Verbindungen