Guia do usuário do Chatwoot
Pesquise os artigos aqui ou navegue pelas categorias abaixo.
Navegar por tópico
Encontre guias, tutoriais e respostas organizados por categoria.
Primeiros passos
Comece por aqui: conceitos, primeiro acesso e onboarding do Chatwoot.
Configurar a conta
Perfil, agentes, times, configurações gerais e envio de e-mails (SMTP).
Canais de atendimento
Conecte seus canais: WhatsApp Web, site, e-mail, Instagram, Facebook, Telegram, SMS e API.
Bate-papo ao vivo no site
Instale e configure o widget de chat ao vivo no seu site.
Recursos explicados
Contatos, marcadores, respostas prontas, atributos personalizados, CSAT e mais.
Recursos avançados
Automação, macros, campanhas, filtros, webhooks e o Kanban de conversas.
IA: Eva e Copilot
Configure a assistente de IA Eva, o Copilot e a base de conhecimento.
Aplicativos e integrações
Integre o Chatwoot com Dialogflow, Slack, Google Translate, OpenAI e outros apps.
Relatórios
Acompanhe métricas de conversas, agentes, CSAT e bots.
Como fazer — guias rápidos
Guias rápidos para tarefas do dia a dia.
Melhores práticas
Recomendações para organizar o atendimento e a sua equipe.
Migrações
Migre de outras plataformas para o Chatwoot.
Central de Ajuda
Crie, personalize e publique a sua própria central de ajuda.
Outros tópicos
Aplicativos móveis, idiomas, notificações e outros temas.
Artigos populares
O que outras pessoas estão lendo agora.
Conectar o WhatsApp Web (QR Code)
Fluxo para conectar o WhatsApp Web: adicionar a caixa de entrada, escolher o provedor WhatsApp Web, informar nome e número, gerar o QR Code e escaneá-lo com o celular. O WhatsApp Web é a forma principal de conectar o seu número de WhatsApp ao Chatwoot para atender seus clientes. A conexão é feita escaneando um QR Code com o celular — sem precisar de credenciais do Meta Business. É rápido e funciona com o seu número atual. Neste artigo você vai criar uma caixa de entrada de WhatsApp Web e deixá-la pronta para receber e responder mensagens. Antes de começar - Tenha o celular com o WhatsApp instalado e ativo no número que você quer conectar, com acesso à internet. - Anote o número no formato internacional (E.164), com o código do país e DDD — por exemplo: +5511999999999. - Você precisa de permissão de administrador para adicionar caixas de entrada. Passo a passo 1. No menu lateral, acesse Configurações. 2. Abra Caixas de Entrada e clique em Adicionar caixa de entrada. 3. Escolha o canal WhatsApp. 4. Em provedor, selecione WhatsApp Web — "Escaneie o QR Code para conectar diretamente". 5. Na tela Conectar via WhatsApp Web, preencha os campos: - Nome da Caixa de Entrada — informe um nome para identificar a caixa (por exemplo, "Atendimento Acme"). - Número de Telefone — digite seu número do WhatsApp no formato internacional, ex.: +5511999999999. 6. Clique em Gerar QR Code. Escanear o QR Code Com o QR Code gerado, a tela Escaneie o QR Code exibe as instruções em Como escanear: 1. Abra o WhatsApp no seu celular. 2. Toque em Menu ou Configurações e selecione Aparelhos conectados. 3. Aponte a câmera do seu celular para esta tela para capturar o QR code. Enquanto a conexão é feita, aparece a mensagem "Aguardando você escanear o QR code...". Assim que o celular reconhecer o código, a caixa de entrada é conectada. Se o QR Code expirar antes de você escanear, clique em Atualizar QR Code para gerar um novo. Opções adicionais Na configuração do WhatsApp Web você encontra alguns ajustes opcionais (também disponíveis depois nas configurações da caixa de entrada): - Ignorar mensagens de grupos — quando ativado, mensagens de grupos do WhatsApp não serão importadas. - Importar histórico de mensagens — as mensagens existentes serão importadas ao conectar. - Incluir nome do agente nas mensagens — adiciona o nome do agente em negrito no início de cada mensagem de texto enviada por essa caixa. Conectar depois Se preferir, você pode usar a opção Pular e Criar Caixa de Entrada e escanear o QR Code em outro momento. Nesse caso, você pode conectar ao WhatsApp depois pela página de configurações da caixa de entrada. Número divergente Ao escanear, o WhatsApp Web confere se o celular usado corresponde ao número informado no cadastro. Se você escanear com um número diferente, aparece o aviso "Número de telefone divergente", informando o número esperado e o número que foi conectado. Nesse caso, escaneie novamente usando o celular com o mesmo número que você informou no campo Número de Telefone. Pronto! Sua caixa de entrada de WhatsApp Web está conectada e já pode receber e responder mensagens dos seus clientes diretamente no Chatwoot.
Canais de atendimentoComo configurar um canal de e-mail?
Fluxo para configurar um canal de e-mail: adicionar a caixa de entrada, informar nome e e-mail de suporte, adicionar agentes e configurar IMAP para receber e SMTP para enviar. Para gerenciar os e-mails de suporte ao cliente (tickets) pelo Chatwoot, você pode criar uma caixa de entrada de e-mail. Este é um guia completo para colocar seu canal de e-mail em funcionamento. Este documento está dividido em três partes: 1. Criando uma caixa de entrada de e-mail 2. Configurações para usuários do Gmail 3. Criando uma caixa de entrada de e-mail da Microsoft Sinta-se à vontade para pular para qualquer seção. Como criar uma caixa de entrada de e-mail no Chatwoot? Passo 1. Abra o painel do Chatwoot. Vá para Configurações → Caixas de Entrada → Adicionar caixa de entrada. Passo 2. Clique no ícone E-mail. Passo 3. Informe o nome do canal (como você quer se referir a este canal) e o seu e-mail de suporte, depois clique no botão Criar canal de e-mail. Obs.: você também verá a opção de selecionar a Microsoft como provedor de e-mail. Se você usa um e-mail do Outlook/Microsoft, vá direto para a seção Como criar uma caixa de entrada de e-mail da Microsoft? (última seção). Passo 4. Adicione agentes à sua caixa de entrada de e-mail. Pronto: você criou uma caixa de entrada de e-mail. Passo 5. Defina as configurações de e-mail. Vá para Configurações → Caixas de Entrada → configurações da caixa de entrada de e-mail → aba Configuração. Você verá três configurações principais aqui: 1. Encaminhar para o e-mail 2. Configurar IMAP 3. Configurar SMTP As três são explicadas nas seções a seguir. Como encaminhar e-mails para a caixa de entrada do Chatwoot? Passo 1. Copie o endereço em Encaminhar para o e-mail, na aba Configuração das configurações da caixa de entrada. Passo 2. Configure o endereço copiado como endereço de encaminhamento na sua conta de e-mail. Obs.: consulte a seção do Gmail, mais abaixo, para saber como adicionar um endereço de encaminhamento no Gmail. Passo 3. Envie um e-mail para o endereço que você configurou o encaminhamento e verifique se ele chega na caixa de entrada de e-mail do Chatwoot. Como configurar o IMAP no canal de e-mail? Se você usa o Gmail, veja também a seção Como ativar o IMAP na caixa de entrada do Gmail?, mais abaixo. Passo 1. Vá para Configurações → Caixas de Entrada → configurações da caixa de entrada de e-mail → aba Configuração. Passo 2. Marque a caixa de seleção Ativar configuração IMAP para esta caixa de entrada. Os campos obrigatórios aparecerão: 1. Endereço 2. Porta 3. E-mail 4. Senha Obs.: se você usa o Gmail, a autenticação é feita com uma senha de app — role até Como gerar uma senha de app para o Gmail? para gerá-la e usá-la no campo Senha. Passo 3. Teste se está tudo funcionando. Envie um e-mail para a conta configurada no IMAP e verifique a caixa de entrada do Chatwoot. Abra a conversa de e-mail e confira os detalhes da mensagem. Como configurar o SMTP no canal de e-mail? Passo 1. Vá para Configurações → Caixas de Entrada → configurações da caixa de entrada de e-mail. Passo 2. Selecione a aba Configuração. Passo 3. Marque a caixa de seleção Ativar configuração SMTP para esta caixa de entrada. Preencha os campos abaixo e clique em Atualizar. 1. Endereço 2. Porta 3. E-mail 4. Senha 5. Domínio Obs.: se você usa o Gmail, a autenticação é feita com uma senha de app — role até Como gerar uma senha de app para o Gmail? para gerá-la e usá-la no campo Senha. Passo 4. Abra uma conversa de e-mail existente no Chatwoot. Passo 5. Digite uma resposta e clique em Enviar. Confirme se a mensagem foi entregue — você também pode verificar a caixa de entrada do destinatário. Configurações para usuários do Gmail Acesso IMAP no Gmail Em contas pessoais do Gmail, o acesso IMAP já fica ativo e o antigo botão Ativar IMAP não existe mais. Basta usar imap.gmail.com, porta 993, SSL e uma senha de app. Em contas do Google Workspace, o administrador da organização pode restringir o acesso; se a autenticação falhar, confirme a política com ele. Veja a orientação atual do Gmail para outros clientes de e-mail. Como gerar uma senha de app para o Gmail? Observação: a senha de app é necessária para contas do Gmail com a verificação em duas etapas ativada. Ative a verificação em duas etapas antes de gerar a senha. Passo 1. Ative a verificação em duas etapas e abra a página Senhas de app da Conta Google. Passo 2. Crie uma senha de app com um nome identificável, como Chatwoot. Passo 3. Copie a senha de 16 caracteres gerada e use-a nos campos Senha de IMAP e SMTP. Ela pode não estar disponível em contas corporativas com restrições, no Programa Proteção Avançada ou quando a verificação em duas etapas usa apenas chaves de segurança. Como adicionar um endereço de encaminhamento no Gmail? Passo 1. Abra sua caixa de entrada do Gmail e clique no ícone de configurações no canto superior direito. Clique em Ver todas as configurações. Passo 2. Selecione a aba Encaminhamento e POP/IMAP. Passo 3. Clique em Adicionar um endereço de encaminhamento. Informe o endereço de encaminhamento do Chatwoot e clique em Avançar. Passo 4. Confirme o endereço no pop-up do navegador. O Gmail enviará um código de verificação para o endereço de encaminhamento. Passo 5. Copie o código de verificação recebido na caixa de entrada de e-mail do Chatwoot. Passo 6. Cole o código e clique em Verificar. Passo 7. Selecione a opção Encaminhar uma cópia dos e-mails recebidos, escolha a ação desejada no segundo menu suspenso e clique em Salvar alterações. Como criar uma caixa de entrada de e-mail da Microsoft? Passo 1. Abra o painel do Chatwoot. Vá para Configurações → Caixas de Entrada → Adicionar caixa de entrada. Passo 2. Clique no ícone E-mail. Passo 3. Clique no ícone Microsoft. Passo 4. Informe o seu e-mail do Outlook/Microsoft. Passo 5. Faça login com suas credenciais Microsoft/Outlook. Passo 6. Permita que o aplicativo Chatwoot leia e responda aos seus e-mails. Passo 7. Adicione agentes à sua caixa de entrada de e-mail. Pronto: você criou uma caixa de entrada de e-mail da Microsoft. Passo 8. Para revisar essa integração depois, abra Configurações → Caixas de Entrada e selecione a caixa da Microsoft. Como a conexão usa OAuth, não há uma aba para preencher manualmente os dados de IMAP e SMTP. Se a autorização expirar ou for revogada, essa página exibirá um aviso com o botão para autorizar novamente a conta Microsoft.
Recursos explicadosComo usar bots de agente?
Fluxo de um bot de agente: a conversa entra como pendente, o bot recebe eventos por webhook, processa e gera a resposta, publica pela API do Chatwoot e transfere para um agente humano quando necessário. Os bots de agente (Agent Bots) permitem conectar bots externos e a lógica do seu próprio bot diretamente a uma caixa de entrada do Chatwoot. Com a API de Bot de Agente, o seu bot pode ouvir as conversas dos clientes, processar as mensagens recebidas e responder através do Chatwoot em tempo real. Disponibilidade: bots de agente estão incluídos a partir do plano Profissional. Quando um bot de agente está conectado a uma caixa de entrada, toda nova conversa recebe automaticamente o status pendente. O Chatwoot então envia os eventos da conversa para a URL configurada do seu bot como eventos de webhook. O seu bot pode processar esses eventos, gerar a resposta certa usando a sua própria lógica ou sistemas de IA e devolver mensagens para a conversa usando as APIs do Chatwoot — mantendo sempre a transferência para um agente humano disponível quando necessário. Procurando um assistente de IA pronto para usar? A nossa plataforma já inclui a Eva, o assistente de IA nativo, que funciona sem escrever código. Se você só quer uma IA atendendo na sua caixa de entrada, comece pela Introdução à Eva. Os bots de agente descritos aqui são o mecanismo genérico para conectar o seu próprio bot ou automação externa via webhook. Como funciona um bot de agente? Veja abaixo o fluxo de trabalho típico de um bot de agente. 1. O bot recebe eventos como webwidget_triggered, message_created, message_updated e conversation_status_changed com base nas interações do cliente. 2. O bot processa as informações recebidas para gerar uma resposta apropriada. 3. O bot também pode consultar APIs de sistemas externos para reunir informações adicionais do cliente, como status de pedido ou dados de reserva. 4. O bot pode integrar modelos de IA como OpenAI, Claude ou Gemini, ou ferramentas como o Amazon Lex, para entender o que o cliente deseja. 5. O bot pode publicar a resposta gerada de volta na conversa usando as APIs do Chatwoot, como a de criar uma nova mensagem. 6. O bot pode alternar o status de uma conversa para aberto para transferi-la a um agente humano. 7. Ele continua monitorando as conversas abertas para fornecer informações de contexto ao agente de atendimento. Como funciona a transferência para um agente humano? Quando um bot de agente está conectado a uma caixa de entrada, as conversas são criadas com status pendente, permitindo que o bot faça a triagem antes de repassá-la a um agente humano. Se o bot concluir que a ajuda de um humano é necessária, ele pode usar a API de atualização de conversa para alterar o status para aberto. Às vezes, um agente precisa devolver ao bot uma conversa que já havia sido transferida. Basta alterar o status de volta para pendente para recolocá-la na fila do bot. Como posso usar um bot de agente? Alguns exemplos: 1. Empresas com alto volume de atendimento podem usar um bot de agente para qualificar e filtrar solicitações, reduzindo a carga dos agentes humanos e melhorando a eficiência do suporte. 2. Lojas de comércio eletrônico podem integrar o bot aos seus bancos de dados, oferecendo aos clientes atualizações em tempo real sobre status de pedido e entrega, além de responder dúvidas relacionadas. 3. Sites de conteúdo e notícias podem usar o bot para enviar recomendações aos usuários por meio de mensagens. 4. Sites de reservas (hotéis, serviços, ingressos) podem usar o bot para lidar com agendamentos e responder dúvidas, oferecendo uma experiência de reserva prática e ágil. Exemplos históricos da comunidade - Implementação de reservas de hotel usando Dialogflow — repositório arquivado em 2022; use apenas como referência de arquitetura. - Exemplo de implementação usando Rasa — repositório arquivado em 2022; as dependências podem estar desatualizadas. Vale também explorar Como criar mensagens interativas para conhecer os tipos de mensagem que um bot pode enviar. Como adicionar um bot de conta Na plataforma gerenciada, crie um bot de conta pelo painel. Ele fica limitado à sua própria conta; bots globais são administrados somente pela equipe da plataforma. 1. Acesse Configurações → Robôs. 2. Clique em Criar Robô. 3. Informe o nome, uma descrição e a URL do Webhook pública da sua integração. 4. Salve e copie o Token de acesso e o Segredo do Webhook. O token autentica as chamadas do bot à API; o segredo permite verificar que os eventos recebidos foram enviados pela plataforma. 5. Guarde os dois valores no servidor do seu bot. Não os exponha no navegador, em aplicativos móveis ou em repositórios. Conectar o bot a uma caixa de entrada 1. Acesse Configurações → Caixas de Entrada e abra a caixa desejada. 2. Na configuração da caixa, localize Selecione um robô de agente. 3. Escolha o bot e clique em Atualizar. Depois da conexão, faça uma conversa de teste e confirme que o endpoint recebe os eventos e consegue publicar uma resposta. Para remover o vínculo, volte à mesma tela e use Desconectar Robô. Provisionar pela API Integrações que automatizam o provisionamento podem usar a API de bots da conta. A API de bots globais é voltada aos operadores da instalação e não deve ser usada para criar um bot de tenant.
Primeiros passosLição 2: Noções básicas do painel
As quatro regiões do painel: barra de navegação, lista de conversas, área da conversa e painel de contexto do cliente. Na Lição 1 você enviou sua primeira resposta. Isso já basta para atender um cliente. Para atender cinquenta sem se perder, você precisa se orientar no painel — e é esse o mapa que esta lição oferece. Ao final, você saberá: - As quatro regiões do painel e para que serve cada uma - Como encontrar qualquer conversa rápido — por status, responsável, caixa de entrada, marcador ou texto - Os status de conversa e quando usar cada um - A diferença entre as visões Minhas, Não atribuídas, Todas, Menções e Não atendidas - Como definir sua disponibilidade Você vai precisar: da caixa de entrada da Lição 1 e de pelo menos uma conversa de teste nela. (Envie duas ou três mensagens para você mesmo pelo canal — WhatsApp Web ou o chat no site — para o painel não ficar vazio.) As quatro regiões do painel Quase toda tela do Chatwoot segue o mesmo layout. Quando isso "clica", o resto do produto fica óbvio. 1. Barra de navegação (extrema esquerda) Uma faixa vertical de ícones. É por aqui que você troca de página; tudo o mais muda conforme onde você está. De cima para baixo: - Caixa de Entrada — pessoas entrando em contato com você - Conversas — onde você passa a maior parte do turno - Contatos — as pessoas que já falaram com você - Relatórios — estatísticas das suas conversas - Campanhas — contato proativo com o cliente - Central de Ajuda — sua base de conhecimento - Configurações — configurações da conta Os assistentes da Eva são configurados em Configurações → Assistentes Eva. Já o Copiloto Eva aparece dentro da conversa, quando o recurso está habilitado para a conta. 2. Lista de conversas (centro-esquerda) Uma lista rolável de conversas, com filtros e abas no topo. É aqui que você vive durante o expediente. - Mude o layout — escolha como visualizar o painel; você pode ocultar a fila de conversas para dar mais espaço à conversa aberta. - Filtrar conversas — combine filtros para ver só as conversas que interessam. - Cada cartão de conversa mostra a caixa de entrada/canal de onde a conversa veio (WhatsApp Web, chat no site, e-mail…), o agente atribuído, a última mensagem, o horário e os marcadores associados. 3. Área da conversa (centro) As mensagens em si, mais a caixa de resposta. As abas no topo do compositor alternam entre Responder, Nota Privada e, quando o canal permite, E-mail. Na caixa de resposta você pode formatar o texto, inserir emojis, anexar arquivos ou até gravar uma nota de voz. Use o ícone no canto superior direito para expandir o campo. No cabeçalho da conversa ficam as ações rápidas: - Silenciar — pare de receber notificações de uma conversa. - Enviar transcrição — mande o histórico completo do bate-papo para o cliente, para o agente ou para qualquer e-mail. - Resolver conversa — encerre quando o assunto do cliente estiver resolvido (mais sobre status logo abaixo). 4. Painel de contexto (direita) Tudo que você precisa saber sobre o cliente e sobre a conversa fica aqui: - Detalhes do contato — visão concisa das informações disponíveis, com as opções Nova mensagem, Editar contato, Mesclar contato e Excluir contato. Clique no ícone ao lado do nome para uma visão expandida. - Ações da conversa — atribua um Agente, encaminhe para uma Equipe e adicione Marcadores. - Macros — execute uma sequência de ações predefinidas com um clique. - Informações da conversa e Atributos do contato — dados personalizados definidos nas configurações da conta. - Notas do contato, Conversas anteriores e Participantes da conversa. Não se preocupe em dominar cada item agora — a Lição 3 se aprofunda nessas ferramentas. Uma conversa aberta no painel do Chatwoot: a lista de conversas à esquerda, a conversa no centro e o painel de contexto do contato à direita Os status de conversa Toda conversa tem um status. Saber usá-los mantém sua fila limpa. - Aberta — conversa ativa que ainda precisa de atenção. - Pendente — enviada para a lista de pendentes; útil para triagem ou quando algo interno precisa acontecer antes de responder. - Adiada — use Adiar até quando precisar esperar um prazo ou uma resposta do cliente e ainda não puder encerrar; ela volta para você no momento certo. - Resolvida — encerre quando o problema do cliente estiver resolvido. Marcar como pendente e Adiar até ficam no menu ao lado do botão Resolver conversa. As visões de conversa No topo da lista de conversas, alterne entre estas abas para achar rápido o que importa: - Minhas — conversas atribuídas a você. - Não atribuídas — conversas ainda sem nenhum agente designado. - Todas — todas as conversas da caixa de entrada. - Menções — conversas em que você foi mencionado em uma nota privada. - Não atendidas — conversas que ainda não receberam resposta. Sua disponibilidade Seu status de disponibilidade avisa à equipe se você pode receber conversas. Alterne entre Online, Ocupado e Offline conforme o seu turno. Sentiu-se confiante com o painel? Provavelmente levou uns 5 minutos! A seguir, vamos dominar os recursos principais. Ir para a Lição 3A agora.
Canais de atendimentoComo criar uma caixa de entrada de canal API?
Partes do canal API: configuração com URL de retorno de chamada, envio de mensagens pela API, recebimento de eventos via callback e APIs de cliente para interfaces e tempo real. Para criar e configurar uma caixa de entrada de canal API no Chatwoot, siga os passos descritos abaixo. O canal API é um canal genérico: em vez de se conectar a uma rede pronta (como o WhatsApp Web ou o chat no site), ele expõe uma API para enviar e receber mensagens. Por isso, é o ponto de conexão ideal para bots e integrações externas. Disponibilidade: o canal API está incluído a partir do plano Profissional. A Eva nativa não precisa deste canal; use-o somente para uma integração que você mesmo desenvolve ou opera. Configure o canal API Passo 1. Vá para Configurações → Caixas de Entrada → Adicionar caixa de entrada. Passo 2. Clique no ícone API. Passo 3. Informe um nome para o canal e uma URL de retorno de chamada (callback). É para essa URL que o Chatwoot enviará os eventos (por exemplo, cada nova mensagem). Passo 4. Adicione os agentes que vão atender essa caixa de entrada e conclua. A configuração da caixa de entrada está concluída. Conecte bots e integrações externas O canal API é um ponto de conexão para bots e integrações externas: por expor uma API genérica de entrada e saída, ele permite plugar qualquer sistema que envie e receba mensagens pela conta. O restante deste guia explica esse fluxo. Envie mensagens para o canal API Para enviar mensagens ao canal API, é importante entender os seguintes conceitos e a nomenclatura usada no Chatwoot: 1. Canal: define o tipo de origem das conversas. Por exemplo, WhatsApp Web, chat no site, API, etc. 2. Caixa de entrada: você pode criar várias fontes de conversas do mesmo tipo de canal. Por exemplo, é possível ter mais de uma caixa de entrada de API na mesma conta. Cada uma é uma caixa de entrada no Chatwoot. 3. Conversa: uma conversa é um conjunto de mensagens. 4. Contato: cada conversa tem uma pessoa real associada a ela, chamada de contato. 5. Caixas de entrada de contato (contact inboxes): é a sessão de cada contato dentro de uma caixa de entrada. Um contato pode ter várias sessões e várias conversas na mesma caixa de entrada. Como enviar uma mensagem em um canal API? Para enviar uma mensagem em um canal API, crie um contato, inicie uma conversa e, por fim, envie a mensagem. As chamadas exigem o api_access_token no cabeçalho da requisição. Você obtém esse token nas configurações do seu perfil → Token de acesso. 1. Crie um contato Passe o ID da caixa de entrada do canal API junto com os demais parâmetros. Isso cria uma sessão automaticamente. Um exemplo de resposta: { "email": "string", "name": "string", "phone_number": "string", "thumbnail": "string", "additional_attributes": {}, "contact_inboxes": [ { "source_id": "string", "inbox": { "id": 0, "name": "string", "channel_type": "string", "enable_auto_assignment": true, "greeting_enabled": true, "greeting_message": "string" } } ], "id": 0, "pubsub_token": "string", "availability_status": "string" } No corpo da resposta você verá contact_inboxes, e cada contact_inbox traz um source_id. O source_id funciona como identificador da sessão — você o usará para criar uma nova conversa. 2. Crie uma conversa Use o source_id recebido na chamada anterior. Você receberá o ID da conversa, que servirá para criar mensagens. { "id": 0 } 3. Crie uma nova mensagem Existem 2 tipos de mensagem: 1. Recebida (incoming): mensagens enviadas pelo usuário final. 2. Enviada (outgoing): mensagens enviadas pelo agente. Ao chamar a API com o conteúdo correto, você recebe uma resposta parecida com esta: { "id": 0, "content": "This is a incoming message from API Channel", "inbox_id": 0, "conversation_id": 0, "message_type": 0, "content_type": null, "content_attributes": {}, "created_at": 0, "private": false, "sender": { "id": 0, "name": "Contato", "type": "contact" } } Se tudo correr bem, a conversa aparecerá no painel. Receba mensagens usando a URL de retorno de chamada Quando uma nova mensagem é criada no canal API, o Chatwoot envia uma requisição POST para a URL de retorno de chamada informada na criação do canal. O tipo de evento é message_created e o corpo tem este formato: { "id": 0, "content": "This is a incoming message from API Channel", "created_at": "2020-08-30T15:43:04.000Z", "message_type": "incoming", "content_type": null, "content_attributes": {}, "source_id": null, "sender": { "id": 0, "name": "contact-name", "avatar": "", "type": "contact" }, "inbox": { "id": 0, "name": "API Channel" }, "conversation": { "additional_attributes": null, "channel": "Channel::Api", "id": 0, "inbox_id": 0, "status": "open", "agent_last_seen_at": 0, "contact_last_seen_at": 0, "timestamp": 0 }, "account": { "id": 1, "name": "API testing" }, "event": "message_created" } Esse é o mecanismo que um bot ou integração externa usa para "ouvir" a conta: cada evento chega na URL de retorno de chamada, e a integração responde pela API. Crie interfaces usando as APIs de cliente As APIs de cliente disponíveis para o canal API ajudam você a construir interfaces voltadas ao cliente sobre o Chatwoot. Elas são úteis em casos como: 1. Usar uma interface de chat personalizada no lugar do widget do Chatwoot. 2. Criar interfaces de conversa em aplicativos móveis. 3. Integrar o Chatwoot a plataformas para as quais não há um SDK oficial. Criando objetos de cliente Você pode criar e recuperar os objetos do cliente usando o inbox_identifier da caixa e o source_id retornado ao criar o contato. Identificador da caixa de entrada — obtenha o inbox_identifier na sua caixa de entrada de canal API, na aba Configuração das configurações da caixa de entrada. Identificador do cliente — o source_id é retornado ao criar o contato. Guarde-o de forma segura no cliente para fazer as próximas requisições dessa identidade. Com essas APIs você pode, entre outras coisas: - Criar, visualizar e atualizar contatos - Criar e listar conversas - Criar, listar e atualizar mensagens Autenticação HMAC As APIs de cliente também oferecem autenticação HMAC. Copie o token HMAC na aba Configuração da caixa de entrada do canal API. Mantenha esse token apenas no seu servidor e use-o para assinar os identificadores dos clientes; não o exponha no aplicativo ou no navegador. Conectando-se ao Chatwoot em tempo real Para receber atualizações em tempo real, conecte-se aos WebSockets do Chatwoot usando a URL: <url da sua instalação>/cable Autenticando sua conexão WebSocket Ao se inscrever usando o pubsub_token do cliente, você passa a receber os eventos direcionados ao seu objeto de cliente. O pubsub_token é retornado na chamada de criação do contato. Exemplo: const customerPubsubToken = '<pubsub_token retornado ao criar o contato>'; const connection = new WebSocket('wss://sua-empresa.hub.chatwoot.app.br/cable'); connection.addEventListener('open', () => { connection.send(JSON.stringify({ command: 'subscribe', identifier: JSON.stringify({ channel: 'RoomChannel', pubsub_token: customerPubsubToken, }), })); });
Primeiros passosLição 1 (a): Sua primeira conversa no Chatwoot
Passo a passo da primeira conversa: adicione uma caixa de entrada, escolha o canal Site, preencha os campos, envie uma mensagem pelo widget e responda no painel. Como usuário do Chatwoot, você poderá gerenciar várias conversas com vários clientes, vindas de vários canais, em um único painel. Vamos destrinchar a palavra-chave dessa frase: canais. O que é um canal? Um canal é o meio de comunicação que o seu cliente escolhe para falar com você. No Chatwoot, você reúne todos eles em um só lugar. Qualquer um dos itens abaixo pode ser um canal: - WhatsApp Web — o canal principal da nossa plataforma. Você conecta escaneando um QR Code com o seu celular, sem precisar de credenciais do Meta Business. - Chat ao vivo no site ou no aplicativo (o widget de conversa) - E-mail de suporte ou de atendimento - Instagram e Facebook (mensagens diretas) - Telegram - SMS - Qualquer outro aplicativo relevante para o seu negócio, conectado por meio de API Você pode conectar um ou todos esses canais à sua conta Chatwoot e conversar com os seus clientes por qualquer um deles. Dica: no Chatwoot, uma instância de um canal é chamada de caixa de entrada. Como o Chatwoot funciona para você? Com base nos canais que você escolher manter para a sua organização, os seus clientes poderão falar com você por qualquer um deles. Digamos que você habilite o WhatsApp Web da sua empresa, o chat ao vivo do site e o suporte por e-mail. A primeira interação de um novo atendimento cria uma conversa no Chatwoot; as mensagens seguintes desse mesmo atendimento são acrescentadas à conversa existente. Cada nova conversa é listada em ordem cronológica no painel (a mais recente no topo). Pense como no seu próprio WhatsApp ou Gmail: sempre que alguém envia uma mensagem nova, ela aparece no topo da lista e você atende quando puder. Esta é a aparência de uma lista típica de conversas vindas de diferentes canais no seu painel: Lista de conversas no painel do Chatwoot, com conversas de diferentes canais e a barra lateral de caixas de entrada e times Experimente agora: crie a sua primeira conversa. Inscreva-se para obter a sua conta e você já poderá configurar a sua primeira caixa de entrada conosco. O WhatsApp Web é o nosso canal principal, e ele tem uma lição só para ele: siga a Lição 1 (b): Conectar o WhatsApp Web para parear o seu número por QR Code — o passo a passo completo está em Conectar o WhatsApp Web (QR Code). Para esta primeira lição, vamos usar o exemplo mais rápido de todos — o chat no site — só para você ver uma conversa chegando ao painel: Passo 1. Vá em Configurações → Caixas de Entrada → Adicionar caixa de entrada. Passo 2. Selecione o canal Site. Passo 3. Preencha os campos que aparecem na tela. Para entender o que cada campo significa e finalizar a configuração, veja este guia detalhado. Passo 4. Acesse o site onde você ativou o chat ao vivo. Abra o widget de conversa e envie uma mensagem. Passo 5. Agora abra o painel do Chatwoot: você vai ver a mensagem chegando e já pode respondê-la! 🎉 Parabéns! Você já tem uma conta Chatwoot ativa e recebeu a sua primeira conversa. Vamos em frente. O que fazer quando você recebe uma conversa? Resposta curta: é só conversar! Resposta longa: ao abrir uma conversa, você responde na caixa de resposta. O Chatwoot envia a sua mensagem ao cliente pelo mesmo canal por onde ele falou com você. Por exemplo: se um cliente enviar um e-mail sobre um problema de entrega e você responder pela caixa de resposta do Chatwoot, ele recebe a sua resposta na própria caixa de entrada de e-mail — e pode responder por lá mesmo. O mesmo vale para o WhatsApp Web: você responde no Chatwoot e o cliente recebe no WhatsApp dele. Essa troca contínua de mensagens facilita a conversa entre você e o seu cliente. Você nunca precisa sair da janela do Chatwoot, e o seu cliente nunca precisa sair do canal que já está usando para falar com você. Além de responder, você vai encontrar muitas opções no painel — Notas privadas, Ações da conversa, Macros e pelo menos mais uma dúzia de recursos. Pode parecer muita coisa, mas relaxe: todos eles existem para você atender melhor e mais rápido os seus clientes. Vamos explorar o painel e conhecer tudo em detalhe na próxima lição.