Widget de chat

Todos os endpoints utilizados pelo widget de chat integrado no seu website.

O widget de chat integra o seu chatbot no seu website. Este grupo descreve todos os endpoints que o widget utiliza: verificação de disponibilidade, configuração pública do widget, envio de mensagens, histórico de conversação, obtenção de novas mensagens (por exemplo, após a transferência para um colaborador), avaliação, eventos de utilização, bem como entrada e saída de voz.

`health` e `config` são acessíveis sem autenticação para que o widget possa ser inicializado no browser. Todos os outros endpoints esperam o `widget_code` e o token de incorporação do widget no cabeçalho `X-Widget-Token`. A Zentor cria o widget durante a configuração, regista os domínios autorizados e fornece-lhe o código de incorporação com o código do widget e o token de incorporação. O servidor rejeita chamadas de domínios não autorizados com 403 `WIDGET_ORIGIN_DENIED` e responde a chamadas para um widget desativado com 404 `WIDGET_DISABLED`.

Aplicam-se também as regras de acesso da sua conta (regras de IP, país e domínio). `message` não é idempotente: cada novo envio cria uma nova mensagem e uma nova resposta.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← Referência API