Este caso de uso descreve etapas exemplo da configuração e uso de API, necessárias para integrar a funcionalidade de chat (opcionalmente co-navegação) em um sistema de terceiros.
Glossário
- Customer é um usuário que escreve uma mensagem pelo chat.
- User/Agent é o usuário/agente que responde no chat.
Etapas
1. Configuração e implementação de script
Configuração de plug-in
Ative e configure seu plugin do WebChat.
- Color
- Texts
- Appearence
- ...
Integração do JavaScript
O JavaScript precisa ser integrado em cada página da Web onde desejamos fazer a co-navegação.
2 - Controle a visibilidade do chat
Observação: Se nada for configurado, o chat fica visível por padrão.
Você pode definir suas regras de ação individuais para controlar a visibilidade do chat:
- Any agent is online
- Any agent is available
- Opening hours
- Visitor is on page for x seconds
- Visitor visits page for second time
ou você pode controlar com a REST API.
API REST para definir a visibilidade do chat
📌Lembrete: A REST API e as regras de ação também podem ser combinadas.
3. Sincronize seus agentes
Se estiver usando um ambiente de terceiros para gerenciar seus agentes, você pode simplesmente sincronizar as contas do agente com o Chatvisor com nossa REST API.
4. Marque seus clientes que correspondam às suas IDs internas
Às vezes, você deseja re-identificar seus clientes e deseja ampliá-los com informações adicionais. Portanto
REST API para marcar seus clientes
{
"email": "[email protected]",
"firstname": "John",
"id": 123,
"labels": [
"foo",
"bar"
],
"lastname": "Doe"
}
5. Receber novas conversas/mensagens
WebHooks
WebHooks podem ser configurados em Settings - API - WebHooks. Você recebe um webhook quando uma nova conversa é iniciada ou uma nova mensagem é recebida. Se nenhuma regra de roteamento automático estiver configurada no Chatvisor, você pode encaminhar manualmente a conversa para um de seus agentes e gerar um URL público para participar da conversa.
REST API
Você também pode pesquisar as conversas com a REST API.
6. Gere um URL de chat público para o agente
Depois que a conversa/cliente for criada com sucesso, é possível gerar um URL público para participar da conversa. Para isso, precisamos da[customerId] o que recebemos do WebHook ou da Conversation API.
📌Lembretes:
- Autentique e gere um token de API. Acesse a documentação
- Este é um URL exclusivo em que o agente é automaticamente conectado e redirecionado para o chat em questão.
7 - Como ação opcional, integre também a co-navegação
Você só precisa habilitar o plugin de co-navegação e configurá-lo. Em seguida, ele será integrado automaticamente ao Live Chat.