Container V1

Auf dieser Seite finden Sie die API-Dokumentation für die Containermethode zur Implementierung von UI-Modulen. Im Folgenden finden Sie die Agent Assist-Funktionen, die Sie als Komponenten in Ihrem Container implementieren können.

Attribute

Eigenschaft Typ Kommentar
Features String Durch Kommas getrennte Liste der Schlüssel für Agent Assist-Vorschlagsfunktionen, die gerendert werden sollen. Beispiel: „SMART_REPLY, CONVERSATION_SUMMARIZATION“
api-headers String Zusätzliche Header, die in Dialogflow API-Aufrufe aufgenommen werden sollen. Beispiel: „Content-Type:application/json, Accept:application/json“
conversation-profile String Name des zu verwendenden Konversationsprofils.
agent-desktop AgentDesktop Agent-Desktop-Software, die integriert werden soll.
auth-token String Authentifizierungstoken für API-Aufrufe.
api-key String Optionaler API-Schlüssel für API-Aufrufe.
channel CommunicationChannel Für diese Anwendung verwendeter Kommunikationskanal (Chat, Sprache oder Omni-Channel).
custom-api-endpoint String Optionaler benutzerdefinierter API-Endpunkt, der verwendet werden soll (wenn UI-Module mit einem Proxyserver konfiguriert sind).
Design 'dark' | 'light' Zu verwendendes Farbdesign.
show-header BooleanString Gibt an, ob die Kopfzeile für Agent Assist-Vorschläge angezeigt werden soll.
dark-mode-background String Hintergrundfarbe für den Dark Mode. Wenn keine angegeben sind, werden Standardwerte für die primären unterstützten Agent-Desktops bereitgestellt.
notifier-server-endpoint String Notifier-Serverendpunkt, der für ereignisbasierte Unterhaltungen verwendet werden soll.
event-based-transport EventBasedTransport Transportprotokoll für ereignisbasierte Unterhaltungen.
event-based-library EventBasedLibrary Bibliothek für ereignisbasierte Unterhaltungen.
oauth-client-id String Optionale OAuth-Client-ID für die implizite Authentifizierung, die in einigen Agent-Desktop-Konfigurationen (Genesys Cloud) verwendet wird.
redirect-uri String Optionaler Weiterleitungs-URI, zu dem nach der Authentifizierung navigiert werden soll. Wird in einigen Agent-Desktop-Konfigurationen (Genesys Cloud) verwendet.
genesys-cloud-region String Optionale Region für Genesys Cloud, standardmäßig mypurecloud.com.

Nutzung

Attribute sind stringbasierte Komponenteneigenschaften, die auf folgende Weise festgelegt werden können:

HTML

js <element-selector property-name="value">

JavaScript

js var el = document.querySelector('element-selector'); el.setAttribute('property-name', 'value');

Eingaben

Eigenschaft Typ Kommentar
socketIoConnectOpts SocketIoConnectOpts Zusätzliche Socket.io-Verbindungsoptionen.
config UiModuleContainerConfig Konfigurationsobjekt zum Definieren modulspezifischer Konfigurationen.

Nutzung

Eingaben sind in der Regel JavaScript-Objekte oder andere komplexe Eigenschaftstypen, die der Elementinstanz direkt zugewiesen werden müssen:

const el = document.querySelector('element-selector');
el.propertyName = value;

Typen

Im folgenden Abschnitt finden Sie die benutzerdefinierten Typen, die von der Komponente verwendet werden.

AgentDesktop

"LivePerson" | "GenesysCloud" | "SalesForce" | "Custom"

CommunicationChannel

"chat" | "voice" | "omnichannel"

BooleanString

"true" | "false"

EventBasedTransport

"websocket" | "polling"

EventBasedLibrary

"SocketIo"

SocketIoConnectOpts

interface SocketIoConnectOpts extends SocketIOClient.ConnectOpts {
  auth: {
    token: string;
  };
  withCredentials?: boolean;
}

UiModuleContainerConfig

interface UiModuleContainerConfig {
  knowledgeAssistConfig?: {
    articleLinkConfig: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
  };
  knowledgeAssistV2Config?: {
    articleLinkConfig?: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
    showCopyAnswer: boolean;
    showPasteAnswer: boolean;
  };
  summarizationConfig?: {
    /**
     * Optional callback that can be used to save the generated summary to an
     * external source.
     */
    onSaveSummary?: (
      summary: {
        summary: string;
        conversationDetails: ConversationDetails;
      },
      saveCallbacks: {
        setLoading: () => void;
        setSuccess: (message: string) => void;
        setError: (message: string) => void;
      }
    ) => void;

    /** Whether to show the 'Generate summary' button. */
    showGenerateSummaryButton?: "true" | "false";
  };
}