Webhooks

A biblioteca WebhookClient no Node.js SDK do Oracle Digital Assistant simplifica a configuração de envio e recebimento de mensagens nos canais do Webhook. Se não estiver usando o SDK, aqui está o que você precisa saber sobre a criação de mensagens de entrada.

A chamada para enviar mensagens ao assistente digital (ou habilidade) deve ter:

1. Um cabeçalho X-Hub-Signature contendo o valor SHA256 do payload. A chamada inclui funções que criam esse hash usando a Chave Secreta como chave.

   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 e BOT_WEBHOOK_SECRET são variáveis de ambiente que você define no servidor de Nó. O uso dessas variáveis de ambiente permite que você evite informações sigilosas de codificação diretamente no webhook

2. Um objeto JSON com as propriedades userId, profile e messagePayload:

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

   Propriedade	Descrição	Tipo	0brigatório?
   userId	Um identificador exclusivo do usuário. Esse ID é específico do chamador.	String	Sim
   profile	Propriedades que representam o usuário, como firstName e LastName.	Objeto JSON	Não
   messagePayload	A propriedade messagePayload pode ser text, postback, attachment e location.	Objeto JSON	Sim

   Observação
   
   Se sua habilidade ou assistente digital precisar detectar o idioma do usuário, certifique-se de que profile.locale e profile.languageTag estejam definidos como nulos nas mensagens do Webhook.

A biblioteca WebhookClient no Node.js SDK do Oracle Digital Assistant simplifica a configuração de envio e recebimento de mensagens nos canais do Webhook. Se não estiver usando o SDK, aqui está o que você precisa saber sobre a criação de mensagens de saída.

Publique as chamadas no formato JSON que o Digital Assistant espera, com o cabeçalho de autorização.