Webhooks

Die WebhookClient-Bibliothek im Node.js-SDK von Oracle Digital Assistant vereinfacht die Einrichtung des Senden und Empfangens von Nachrichten in Webhook-Kanälen. Wenn Sie das SDK nicht verwenden, erfahren Sie hier, wie Sie eingehende Nachrichten erstellen.

Der Aufruf zum Senden von Nachrichten an Ihren digitalen Assistenten (oder Skill) muss Folgendes enthalten:

1. Einen X-Hub-Signature-Header, der den SHA256-Wert der Payload enthält. Der Aufruf umfasst Funktionen, die diesen Hashwert mit dem Secret Key als Schlüssel erstellen.

   const body = Buffer.from(JSON.stringify(messageToBot), 'utf8');
       const headers = {};
       headers['Content-Type'] = 'application/json; charset=utf-8';
       headers['X-Hub-Signature'] = buildSignatureHeader(body, channelSecretKey);
   
   ...
   
   function buildSignatureHeader(buf, channelSecretKey) {
       return 'sha256=' + buildSignature(buf, channelSecretKey);
   }
   
   function buildSignature(buf, channelSecretKey) {
       const hmac = crypto.createHmac('sha256', Buffer.from(channelSecretKey, 'utf8'));
       hmac.update(buf);
       return hmac.digest('hex');
   }

   BOT_WEBHOOK_URL und BOT_WEBHOOK_SECRET sind Umgebungsvariablen, die Sie auf dem Knotenserver festlegen. Wenn Sie diese Umgebungsvariablen verwenden, können Sie eine Hartcodierung sensibler Daten direkt im Webhook vermeiden.

2. Ein JSON-Objekt mit den Eigenschaften userId, profile und messagePayload:

   {
    "userId": "33c0bcBc8e-378c-4496-bc2a-b2b9647de2317",
    "profile": {
       "firstName": "Bob",
       "lastName": "Franklin",
       "age": 45
      },
    "messagePayload": {....}
   }

   Eigenschaft	Beschreibung	Typ	Erforderlich?
   userId	Eine eindeutige ID für den Benutzer. Diese ID ist spezifisch für den Aufrufer.	Zeichenfolge	Ja
   profile	Eigenschaften, die den Benutzer repräsentieren, wie firstName und LastName.	JSON-Objekt	Nein
   messagePayload	messagePayload kann text, postback, attachment und location sein.	JSON-Objekt	Ja

   Hinweis
   
   Wenn Ihr Skill oder digitaler Assistent die Benutzersprache ermitteln muss, müssen Sie sicherstellen, dass profile.locale und profile.languageTag in den Webhook-Nachrichten auf Null gesetzt sind.

Die WebhookClient-Bibliothek im Node.js-SDK von Oracle Digital Assistant vereinfacht die Einrichtung des Senden und Empfangens von Nachrichten in Webhook-Kanälen. Wenn Sie das SDK nicht verwenden, erfahren Sie hier, wie Sie ausgehende Nachrichten erstellen.

Sie müssen die Aufrufe in dem von Digital Assistant erwarteten JSON-Format zusammen mit dem Autorisierungsheader veröffentlichen.