JavaScript-Ereignisse für Dialogflow CX Messenger

Dialogflow CX Messenger löst eine Vielzahl von Ereignissen aus, für die Sie Ereignis-Listener erstellen können. Einige Ereignisse haben ein detail-Objektfeld, das weitere Informationen zum Ereignis enthält.

df-messenger-loaded

Der Agent-Dialog wird zuerst geladen.

Detail-Properties:

  • Keine

Beispiel:

window.addEventListener('df-messenger-loaded', () => {
  // Messenger is now ready.
});

df-chat-open-changed

Der Chat wird geöffnet oder geschlossen.

Detail-Properties:

  • isOpen (boolean): neuer Status des Chats

Beispiel:

window.addEventListener('df-chat-open-changed', (event) => {
  console.log(`Chat is ${event.detail.isOpen ? 'open' : 'closed'}`);
});

df-user-input-entered

Der Nutzer hat Text eingegeben.

Detail-Properties:

  • input (string): vom Nutzer eingegebener Wert

Beispiel:

window.addEventListener('df-user-input-entered', (event) => {
  console.log(event.detail.input);
});

df-request-sent

Eine Anfrage wurde an das Dialogflow CX-Back-End gesendet.

Detail-Properties:

  • data (object): Datencontainer
  • data.requestBody (object): gesendete Anfrage

Beispiel:

window.addEventListener('df-request-sent', (event) => {
  console.log('Request', event.detail.data.requestBody);
});

window.addEventListener('df-request-sent', (event) => {
  event.preventDefault(); // Messenger won't send the request.

  // Send request yourself.
});

df-response-received

Eine Antwort ist im Agent-Dialog eingegangen.

Detail-Properties:

  • data (object): Datencontainer
  • data.messages (object[]): Liste der geparsten Antwortnachrichten
  • raw (object): wörtliche Antwort, die empfangen wurde

Beispiel:

window.addEventListener('df-response-received', (event) => {
  // Remove all non-text messages.
  event.detail.data.messages = event.detail.data.messages.filter(message => {
    return message.type === 'text';
  });
});

window.addEventListener('df-response-received', (event) => {
  event.preventDefault(); // Messenger won't handle the response.

  const messenger = document.querySelector('df-messenger');
  event.detail.data.messages.forEach(message => {
    if (message.type === 'text') {
      messenger.renderCustomText(message.text);
    }
  });
});

df-messenger-error

Eine Anfrage an das Back-End schlägt fehl.

Detail-Properties:

  • error (object): aufgetretener Fehler

Beispiel:

window.addEventListener('df-messenger-error', (event) => {
  console.log(event.detail.error);
});

df-session-expired

Die Sitzung mit dem Agent ist abgelaufen.

Detail-Properties:

  • Keine

Beispiel:

window.addEventListener('df-session-expired', () => {
  const messenger = document.querySelector('df-messenger');
  messenger.renderCustomText(`*Session expired*`, /* isBot= */ true);
  messenger.startNewSession({ retainHistory: true });
});

df-session-ended

Die Sitzung wurde beendet.

Detail-Properties:

  • Keine

Beispiel:

window.addEventListener('df-session-ended', () => {
  const messenger = document.querySelector('df-messenger');
  messenger.renderCustomText(`*Session ended*`, /* isBot= */ true);
  messenger.startNewSession({ retainHistory: true });
});

df-url-suggested

URLs vorgeschlagener Ressourcen.

Detail-Properties:

  • suggestedUrls (string[]): Liste der vorgeschlagenen URLs

Beispiel:

window.addEventListener('df-url-suggested', (event) => {
  if (event.detail.suggestedUrls.length === 1) {
    window.location.href = event.detail.suggestedUrls[0];
  }
});

df-accordion-clicked

Der Nutzer hat auf das Akkordeon geklickt.

Detail-Properties:

  • Keine

df-button-clicked

Der Nutzer hat auf eine Schaltfläche geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href der angeklickten Schaltfläche, falls angegeben
  • event (string): Ereignis der angeklickten Schaltfläche, falls angegeben
  • languageCode (string): Sprachcode des Ereignisses, falls angegeben, andernfalls der Hauptsprachcode
  • text (string): Text der angeklickten Schaltfläche
window.addEventListener('df-button-clicked', (event) => {
  event.preventDefault(); // Messenger won't send the "event" request.

  // Handle "event" yourself.
});

df-chip-clicked

Der Nutzer hat auf einen Chip geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href des angeklickten Chips, falls angegeben
  • text (string): Text des angeklickten Chips

df-citation-clicked

Der Nutzer hat auf ein Zitat geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href des Zitates
  • title (string): Titel des Zitates

df-info-card-clicked

Der Nutzer hat auf eine Infokarte geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href der Infokarte
  • title (string): Titel der Infokarte

df-list-element-clicked

Der Nutzer hat auf ein Listenelement geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href des angeklickten Listenelements, falls angegeben
  • event (string): Ereignis des angeklickten Listenelements, falls angegeben
  • languageCode (string): Sprachcode des Ereignisses, falls angegeben, andernfalls der Hauptsprachcode
  • title (string): Titel des Listenelements
window.addEventListener('df-list-element-clicked', (event) => {
  event.preventDefault(); // Messenger won't send the "event" request.

  // Handle "event" yourself.
});

df-image-clicked

Der Nutzer hat auf ein Bild geklickt.

Detail-Properties:

  • actionLink (string): Anker-Href des Bildes, falls angegeben