Eventos de Websocket
Websockets cria uma conexão persistente entre o cliente e o servidor, permitindo a comunicação bidirecional.
O AtendChat suporta uma conexão websocket para obter atualizações em tempo real sobre os eventos que acontecem na plataforma. Qualquer cliente pode se conectar à URL do websocket no AtendChat e se autorizar fornecendo o Token e começar a receber as atualizações. Este guia irá ajudá-lo a configurar uma conexão websocket com o AtendChat e integrar os eventos disponíveis.
Observação: Este é um recurso experimental. A documentação pode mudar a cada lançamento e não há garantia de compatibilidade com versões anteriores. Verifique se você está usando a versão atualizada da implementação.
Por que devo usar uma conexão websocket?
Suponha que você esteja construindo um cliente para Chatwoot. Por exemplo, em um Android ou iOS Client SDK, onde você precisaria ouvir as mensagens mais recentes para atualizar a interface do usuário sem recarregar ou uma extensão para o painel, se quiser melhorar a produtividade de um agente, talvez precise de dados em tempo real.
Configure uma conexão websocket
Para configurar uma conexão websocket com o AtendChat, você precisa iniciar uma conexão com o token pubsub de autenticação fornecido pelo AtendChat. A URL para a conexão é wss:///cable. Ex.: wss://app.chatwoot.com/cable.
Existem dois tipos de tokens pubsub disponíveis no AtendChat.
Token PubSub do usuário : esse token tem os privilégios de um agente ou administrador e receberia todos os eventos documentados abaixo. Você pode obter o token pubsub chamando a API de perfil .
Token PubSub de contato : para cada contato, o Chatwoot geraria um token pubsub para cada sessão que eles tivessem. Você pode se conectar ao websocket usando este token para obter as atualizações da sessão atual. Ao criar um contato usando as APIs públicas, você receberá o pubsub token no payload. Este token só tem acesso aos eventos relacionados à sessão atual, você só receberia os eventos:
Conversa criada
Status da conversa alterado
Mensagem criada
Atualização de mensagem
Digitando na conversa
Atualização de conversa: parou de digitar
Consulte as APIs do cliente para criar integrações voltadas para o cliente em tempo real usando o AtendChat.
Observação: Este token pode ser alternado regularmente com base no seu tipo de instalação, certifique-se de estar usando o token mais recente.
Conecte-se ao AtendChat Websocket
Você precisa enviar um comando "Inscrito" para se conectar ao AtendChat. Ele espera um token pubsub, accountId e userId (se estiver usando um token de usuário). Aqui está um exemplo de como você pode se conectar com o AtendChat.
Atualizado