Webhook Live Chat

Webhooks são um recurso poderoso do NicoChat que permite integrar sua própria plataforma com a automação de chat do NicoChat. Isso é útil se você tiver sua própria plataforma de chat ao vivo e quiser aproveitar os recursos de automação do NicoChat sem direcionar os usuários para a interface do NicoChat.

Quem deve usar Webhooks?

Webhooks são projetados para desenvolvedores que possuem sua própria plataforma e alguma experiência em trabalhar com APIs.

Como configurar Webhooks no NicoChat

Aqui está um guia passo a passo sobre como configurar webhooks no NicoChat:

Configure o URL do seu webhook:

• Vá para Integrações e depois Webhooks.

• Opcionalmente, você pode configurar seus próprios cabeçalhos para segurança adicional.

• Forneça uma URL do Webhook onde você deseja receber os dados.

Open

Ative Webhooks nas configurações do seu canal:

• Acesse as configurações do canal do chat que deseja integrar à sua plataforma (por exemplo, WhatsApp, SMS).

• Em Configurações de chat ao vivo, selecione Webhook.

Open

Use a ação Pausar o bot:

• Em seu fluxo NicoChat, inclua a ação Pausar o Bot onde você deseja que a conversa mude para sua plataforma.

• Quando um usuário interagir após esse ponto, a mensagem será enviada para o URL do seu Webhook.

Open

Exemplo de carga útil

Os dados que o NicoChat envia para o URL do seu Webhook são uma carga JSON que inclui vários detalhes sobre a mensagem e a conversa. Aqui está um detalhamento da carga útil de amostra na imagem:

Open

• meta

  • user_ns: Este é um identificador exclusivo para o usuário.

  • agent_id: Este é o ID do agente atualmente atribuído à conversa (0 indica nenhum agente atribuído).

  • flow_ns: este é um identificador exclusivo para o fluxo de chat.

  • team_id: Este é o ID da equipe à qual o chat pertence.

• mensagem

  • _id: Este é um identificador exclusivo para a mensagem.

  • mid: Este é um identificador exclusivo para a mensagem dentro do canal.

  • type: Indica o tipo de mensagem (por exemplo, "in" para mensagem recebida).

  • msg_type: especifica o tipo de conteúdo da mensagem (por exemplo, "texto").

  • sender_id: Este é o ID do remetente da mensagem.

  • agent_id: Este é o ID do agente que recebeu a mensagem (0 indica nenhum agente atribuído).

  • assigned_agent_id: Este é o ID do agente atribuído à conversa após o recebimento da mensagem.

• payload

  • text: contém o conteúdo de texto da mensagem.

  • content: também contém o conteúdo do texto da mensagem.

  • username: Este é o nome de usuário do remetente da mensagem.

  • date: mostra a data em que a mensagem foi enviada.

  • timestamp: Este é o carimbo de data/hora da mensagem em milissegundos.

  • ts: Esta é outra representação de carimbo de data/hora da mensagem.

  • is_delivered: Indica se a mensagem foi entregue (1 significa entregue).

  • seen: este campo está vazio na carga de exemplo, mas pode indicar se a mensagem foi vista.

Usando a API NicoChat

 Depois de capturar a mensagem do usuário em sua plataforma, você pode usar a API NicoChat para enviar uma resposta de volta ao usuário na conversa de chat. A API NicoChat usa user_ns e flow_ns da carga útil para identificar a conversa e enviar a mensagem.

Considerações adicionais

• Webhooks são uma ferramenta poderosa, mas requerem experiência em desenvolvimento.

• O NicoChat oferece suporte a vários tipos de mensagens e a carga refletirá o tipo de conteúdo (texto, imagem, etc.).

• Aproveite a API do NicoChat para comunicar-se entre sua plataforma e os usuários do NicoChat.

Seguindo essas etapas e compreendendo os dados de carga útil, você pode configurar webhooks para integrar sua própria plataforma com os recursos de automação do NicoChat.