Quando incorporado ao dashboard do ZapiCRM, o seu aplicativo receberá o contexto da conversa e do contato como um evento de janela. Para isso, implemente um listener na sua página para o evento de mensagem e receba o contexto.

P.S. Veja nosso vídeo ao vivo no YouTube sobre como criar um App de Dashboard.

Como criar um aplicativo para o dashboard?

Passo 1: Vá para Configurações → Integrações → Apps de Dashboard. Clique no botão “Configurar” correspondente aos Apps de Dashboard.

Passo 2: Adicione o nome do seu aplicativo e a URL onde ele está hospedado.

Depois de concluído, uma nova aba com o nome escolhido aparecerá na janela de conversa. Neste exemplo, a aba se chamará “Pedidos do Cliente”.

Ao clicar na nova aba, você verá seu aplicativo puxando dados diretamente no dashboard do ZapiCRM.

Recebendo dados do ZapiCRM no seu app

O ZapiCRM enviará o contexto da conversa e do contato como um evento de janela. Para acessá-lo, implemente um listener de evento em seu app, como mostrado abaixo:

window.addEventListener("message", function (event) {

  if (!isJSONValid(event.data)) {

    return;

  }

  const eventData = JSON.parse(event.data);

});

Solicitação de dados sob demanda no ZapiCRM

Caso seja necessário solicitar dados da conversa sob demanda, você pode enviar uma mensagem para a janela principal usando a API postMessage do JavaScript.

O ZapiCRM ficará atento a essa chave: ZapiCRM-dashboard-app:fetch-info.

Exemplo

O código a seguir pode ser usado para consultar o app do dashboard. O ZapiCRM responderá fornecendo os dados atualizados da conversa.

window.parent.postMessage('ZapiCRM-dashboard-app:fetch-info', '*')

Você receberá uma mensagem no listener com os dados do contexto do aplicativo.

Carga útil do evento

{

  "conversation": {

    "meta": {

      "sender": {

        "additional_attributes": {

          "description": "string",

          "company_name": "string",

          "social_profiles": {

            "github": "string",

            "twitter": "string",

            "facebook": "string",

            "linkedin": "string"

          }

        },

        "availability_status": "string",

        "email": "string",

        "id": "integer",

        "name": "string",

        "phone_number": "string",

        "identifier": "string",

        "thumbnail": "string",

        "custom_attributes": "object",

        "last_activity_at": "integer"

      },

      "channel": "string",

      "assignee": {

        "id": "integer",

        "account_id": "integer",

        "availability_status": "string",

        "auto_offline": "boolean",

        "confirmed": "boolean",

        "email": "string",

        "available_name": "string",

        "name": "string",

        "role": "string",

        "thumbnail": "string"

      },

      "hmac_verified": "boolean"

    },

    "id": "integer",

    "messages": [

      {

        "id": "integer",

        "content": "Hello",

        "inbox_id": "integer",

        "conversation_id": "integer",

        "message_type": "integer",

        "content_type": "string",

        "content_attributes": {},

        "created_at": "integer",

        "private": "boolean",

        "source_id": "string",

        "sender": {

          "additional_attributes": {

            "description": "string",

            "company_name": "string",

            "social_profiles": {

              "github": "string",

              "twitter": "string",

              "facebook": "string",

              "linkedin": "string"

            }

          },

          "custom_attributes": "object",

          "email": "string",

          "id": "integer",

          "identifier": "string",

          "name": "string",

          "phone_number": "string",

          "thumbnail": "string",

          "type": "string"

        }

      }

    ],

    "account_id": "integer",

    "additional_attributes": {

      "browser": {

        "device_name": "string",

        "browser_name": "string",

        "platform_name": "string",

        "browser_version": "string",

        "platform_version": "string"

      },

      "referer": "string",

      "initiated_at": {

        "timestamp": "string"

      }

    },

    "agent_last_seen_at": "integer",

    "assignee_last_seen_at": "integer",

    "can_reply": "boolean",

    "contact_last_seen_at": "integer",

    "custom_attributes": "object",

    "inbox_id": "integer",

    "labels": "array",

    "muted": "boolean",

    "snoozed_until": null,

    "status": "string",

    "timestamp": "integer",

    "unread_count": "integer",

    "allMessagesLoaded": "boolean",

    "dataFetched": "boolean"

  }

}

Ao integrar a IA ao seu painel do ZapiCRM, você melhora suas interações com clientes sem perder o tom pessoal ou a identidade da marca. A IA oferece sugestões para refinar suas mensagens, permitindo que você se comunique de maneira mais eficaz.

A configuração é simples e rápida, e os benefícios são imediatos. Siga os passos abaixo para começar.

Como integrar o OpenAI ao ZapiCRM?

Passo 1: Vá para Configurações → Aplicativos → OpenAI e clique no botão “Configurar”.

Passo 2: Clique em “Conectar”. Uma janela modal surgirá pedindo sua chave de API do OpenAI.

Para obter sua chave de API, faça login em sua conta OpenAI e acesse este link. Após inserir sua chave secreta, uma mensagem de sucesso aparecerá na tela.

Como utilizar os recursos de IA no ZapiCRM?

O ZapiCRM oferece três principais funcionalidades alimentadas por IA. Veja como utilizá-las:

Sugestão de Resposta com IA

A funcionalidade “Sugestão de Resposta com IA” oferece respostas rápidas para suas conversas com clientes. Veja como usá-la:

Passo 1: Acesse a aba de conversas no painel e abra uma que precise de resposta. Você verá a opção “Sugestão de Resposta com IA”.

Passo 2: Clique no botão para visualizar a sugestão. A resposta sugerida preencherá automaticamente o campo de resposta.

Passo 3: Edite a mensagem conforme necessário e clique em “Enviar”!

Melhorar com IA

A funcionalidade “Melhorar com IA” sugere ajustes para suas mensagens enquanto você as digita. Veja como usá-la:

Passo 1: Acesse a aba de conversas no painel e comece a digitar uma mensagem. A opção “Melhorar com IA” aparecerá.

Passo 2: Clique no botão para ver as sugestões de melhoria. Escolha um tom para a mensagem, como profissional ou amigável, e clique em “Gerar”.

A IA reescreverá sua mensagem e preencherá o campo de texto com a nova versão.

Passo 3: Edite como quiser e envie!

Resumo com IA

A função “Resumo com IA” cria um resumo de uma conversa dentro das Notas Privadas em questão de segundos. Veja como utilizá-la:

Passo 1: Acesse a aba de conversas no painel e mude para a guia “Nota Privada”. A opção “Resumo com IA” estará disponível.

Passo 2: Clique no botão, e a nota será preenchida automaticamente com o resumo da conversa.

Passo 3: Edite a nota como desejar e clique em “Adicionar Nota”!

Como utilizar o Assistente de IA?

Você pode ativar o Assistente de IA pelo comando na barra de ferramentas ou clicando no botão de Assistente de IA dentro do editor.

Para escolher um recurso, clique na opção desejada. O modal de Sugestão de Resposta com IA será exibido, e você poderá inserir o conteúdo sugerido no editor clicando no botão “Usar esta sugestão”.

Perguntas Frequentes

Os resultados do Assistente de IA são sempre precisos?

Os resultados podem não ser sempre precisos. É importante que os agentes revisem e verifiquem as sugestões da IA antes de enviá-las aos clientes. Estamos trabalhando constantemente para melhorar o Assistente de IA.

Vocês oferecem suporte a outros provedores de IA além do OpenAI?

Atualmente, oferecemos suporte apenas ao OpenAI, mas planejamos adicionar mais provedores em breve.

Como integrar o OpenAI ao ZapiCRM?

Para integrar, siga os passos mencionados acima e comece a melhorar suas conversas com IA.

Como adicionar um webhook?

Passo 1: Vá para Configurações → Integrações → Webhooks e clique no botão “Configurar”.

Passo 2: Clique no botão “Adicionar novo webhook”. Uma janela modal será aberta, onde você deve inserir a URL para a qual a requisição POST será enviada. Depois, selecione os eventos que deseja assinar, para que apenas eventos relevantes no ZapiCRM sejam notificados.

O ZapiCRM enviará uma requisição POST com o seguinte payload para as URLs configuradas, quando ocorrerem atualizações em sua conta.

Exemplo de payload de webhook:

{

  "event": "message_created", // Nome do evento

  "id": "1", // ID da mensagem

  "content": "Oi", // Conteúdo da mensagem

  "created_at": "2020-03-03 13:05:57 UTC", // Data e hora em que a mensagem foi enviada

  "message_type": "incoming", // Pode ser incoming (entrada), outgoing (saída) ou template

  "content_type": "enum", // Pode ser input_select, cards, form ou texto. O valor padrão é texto

  "content_attributes": {}, // Atributos do conteúdo, podem variar

  "source_id": "", // ID externo se for uma integração com Twitter ou Facebook

  "sender": { // Detalhes do agente que enviou a mensagem

    "id": "1",

    "name": "Agente",

    "email": "agent@example.com"

  },

  "contact": { // Detalhes do usuário que enviou a mensagem

    "id": "1",

    "name": "nome-do-contato"

  },

  "conversation": { // Detalhes da conversa

    "display_id": "1", // ID da conversa visível no painel

    "additional_attributes": {

      "browser": {

        "device_name": "Macbook",

        "browser_name": "Chrome",

        "platform_name": "Macintosh",

        "browser_version": "80.0.3987.122",

        "platform_version": "10.15.2"

      },

      "referer": "<http://www.ZapiCRM.com>",

      "initiated_at": "Tue Mar 03 2020 18:37:38 GMT-0700 (Mountain Standard Time)"

    }

  },

  "account": { // Detalhes da conta

    "id": "1",

    "name": "ZapiCRM"

  }

}

Eventos de webhook suportados no ZapiCRM

O ZapiCRM publica vários eventos para os endpoints de webhooks configurados. Cada evento tem sua estrutura de payload baseada no tipo de modelo a que se refere. A seguir, estão descritos os principais objetos usados no ZapiCRM e seus atributos.

Objetos

Um payload de evento pode incluir os seguintes objetos. Os vários tipos de objetos suportados pelo ZapiCRMt estão listados abaixo.

• Conta (Account): { "id": "integer", "name": "string" }
• Caixa de Entrada (Inbox): { "id": "integer", "name": "string" }
• Contato (Contact): { "id": "integer", "name": "string", "avatar": "string", "type": "contact", "account": { // <...Account Object> } }
• Usuário (User): { "id": "integer", "name": "string", "email": "string", "type": "user" }
• Conversa (Conversation): { "additional_attributes": { "browser": { "device_name": "string", "browser_name": "string", "platform_name": "string", "browser_version": "string", "platform_version": "string" }, "referer": "string", "initiated_at": { "timestamp": "iso-datetime" } }, "can_reply": "boolean", "channel": "string", "id": "integer", "inbox_id": "integer", "contact_inbox": { "id": "integer", "contact_id": "integer", "inbox_id": "integer", "source_id": "string", "created_at": "datetime", "updated_at": "datetime", "hmac_verified": "boolean" }, "messages": ["Array of message objects"], "meta": { "sender": { // Contact Object }, "assignee": { // User Object } }, "status": "string", "unread_count": "integer", "agent_last_seen_at": "unix-timestamp", "contact_last_seen_at": "unix-timestamp", "timestamp": "unix-timestamp", "account_id": "integer" }
• Mensagem (Message): { "id": "integer", "content": "string", "message_type": "integer", "created_at": "unix-timestamp", "private": "boolean", "source_id": "string / null", "content_type": "string", "content_attributes": "object", "sender": { "type": "string - contact/user" // User or Contact Object }, "account": { // Account Object }, "conversation": { // Conversation Object }, "inbox": { // Inbox Object } }
• Uma carga útil de webhook de amostra: { "event": "event_name" // Attributes related to the event }

Eventos Webhook

ZapiCRM suporta os seguintes eventos webhook. Você pode assiná-los ao configurar um webhook no painel ou usando a API.

conversation_criado: Disparado quando uma nova conversa é criada.

Este evento será acionado quando uma nova conversa for criada na conta. A carga útil para o evento é a seguinte.

{
  "event": "conversation_created"
  // <...Conversation Attributes>
}

conversação_atualizado

Este evento será acionado quando houver uma alteração em qualquer um dos atributos na conversa.

{
  "event": "conversation_updated",
  "changed_attributes": [
    {
      "<attribute_name>": {
        "current_value": "",
        "previous_value": ""
      }
    }
  ]
  // <...Conversation Attributes>
}

conversation_status_alterado

Este evento será acionado quando o status da conversa for alterado.

Observação: Se você estiver usando APIs de bot de agente em vez de webhooks, esse evento ainda não é suportado.

{
  "event": "conversation_status_changed"
  // <...Conversation Attributes>
}

message_criado

Esse evento será acionado quando uma mensagem for criada em uma conversa. A carga útil para o evento é a seguinte.

{
  "event": "message_created"
  // <...Message Attributes>
}

mensagem_atualizado

Este evento será acionado quando uma mensagem for atualizada em uma conversa. A carga útil para o evento é a seguinte.

{
  "event": "message_updated"
  // <...Message Attributes>
}

webwidget_triggered

Este evento será acionado quando o usuário final abrir o widget de bate-papo ao vivo.

{
  "id": ,
  "contact": {
    // <...Contact Object>
  },
  "inbox": {
    // <...Inbox Object>
  },
  "account": {
    // <...Account Object>
  },
  "current_conversation": {
    // <...Conversation Object>
  },
  "source_id": "string",
  "event": "webwidget_triggered",
  "event_info": {
    "initiated_at": {
      "timestamp": "date-string"
    },
    "referer": "string",
    "widget_language": "string",
    "browser_language": "string",
    "browser": {
      "browser_name": "string",
      "browser_version": "string",
      "device_name": "string",
      "platform_name": "string",
      "platform_version": "string"
    }
  }
}

Dialogflow e Rasa.ai são plataformas líderes em NLP (Processamento de Linguagem Natural) para a criação de chatbots personalizados. Neste guia, explicaremos como criar um bot no Dialogflow e integrá-lo ao ZapiCRM de maneira rápida.

Como criar um bot no Dialogflow?

Passo 1: Acesse o Console do Dialogflow

Utilizaremos o Dialogflow Essentials. Clique em “Create Agent” para iniciar a criação do seu agente.

Passo 2: Crie Intents

Você precisará definir as intenções (intents) de acordo com as respostas que deseja que o bot forneça. O projeto padrão já inclui as intenções “Default Fallback Intent” e “Default Welcome Intent”.

A configuração básica do bot está concluída. Agora, vamos criar uma conta de serviço e conectá-la ao ZapiCRM.

Você pode criar intents adicionais para cenários específicos. O ZapiCRM suporta intents avançadas, que permitem transferências para agentes e mensagens interativas.

Passo 3: Crie uma conta de serviço

Para conectar o bot ao ZapiCRM, você precisa criar uma conta de serviço no Google Cloud. Acesse o console do Google Cloud pelo ID do projeto.

Navegue até IAM & Admin -> Service Accounts e clique em “Create Service Account”. Dê um nome e uma descrição à conta. Em seguida, selecione a opção “Dialogflow API Client” no menu de permissões.

Após criar a conta, vá até a aba “Keys” e clique em “Add Key”. Escolha o formato JSON e clique em “Create”. Baixe a chave gerada e guarde-a para uso posterior.

Configuração da Integração Dialogflow no ZapiCRM

O ZapiCRM tem uma integração nativa com o Dialogflow. Para conectá-lo, siga estes passos:

Passo 1: Acesse “Settings -> Applications -> Dialogflow” no ZapiCRM e clique em “Configure”.

Passo 2: Clique no botão “Add a new hook”. Adicione o “Project ID”, o arquivo de chave do projeto e uma inbox. Cole o conteúdo da chave baixada anteriormente no campo apropriado.

Pronto! A integração está completa. Teste a inbox do site para ver se o bot responde à consulta inicial.

Intents Avançadas

Criação de uma Intent de Transferência

Quando o usuário solicitar falar com um agente, o Dialogflow deve informar o ZapiCRM para que um agente humano assuma a conversa. Crie uma intent chamada “Handoff Intent” com frases como “Falar com um agente”. A resposta deve ser configurada como “Custom Payload” com o seguinte conteúdo:

{

  "action": "handoff"

}

Quando essa intent for acionada, o ZapiCRM alterará o status da conversa para “open” e a transferirá para um agente.

Mensagens Interativas

Atualmente, as mensagens interativas são suportadas apenas na inbox do site. O ZapiCRM e o Dialogflow suportam tipos como:

• Opções (com suporte a follow-up)
• Cartões
• Artigos

Criação de uma Intent de Mensagem Interativa

Para criar uma mensagem interativa de opções, defina a intent com frases de treinamento e use um “Custom Payload”, como no exemplo abaixo:

{

  "content_type": "input_select",

  "content": "Escolha sua comida favorita",

  "content_attributes": {

    "items": [

      {

        "value": "Eu gosto de sushi",

        "title": "Sushi"

      },

      {

        "title": "Biryani",

        "value": "Eu gosto de biryani"

      },

      {

        "title": "Pizza",

        "value": "Eu gosto de pizza"

      }

    ]

  },

  "private": false

}

Quando o usuário interagir com essa mensagem e selecionar uma opção, o Dialogflow receberá essa informação, permitindo a configuração de intents de follow-up.

Como um agente pode devolver a conversa ao bot?

Quando o bot do Dialogflow está conectado a uma inbox, as conversas começam com status “pending”. Isso permite que o bot faça a triagem inicial antes de transferir a conversa para um agente. Caso o agente deseje devolver a conversa ao bot, ele pode alterar o status da conversa de volta para “pending”, e o bot retomará o atendimento.