POST/api/public/widget/voice-speak
Converte texto em fala (saída de voz no widget), se a função de voz estiver ativada.
Envie `widget_code` e o texto a ler em `text`. A resposta contém os dados de áudio para reprodução no navegador. Para reprodução direta através de um elemento `<audio>`, o mesmo caminho está também disponível via GET. Se faltar `widget_code`, o servidor responde 400 `WIDGET_CODE_REQUIRED`; se a função de voz não estiver ativada ou estiver atualmente indisponível, 503 `VOICE_UNAVAILABLE`. A Zentor configura a função de voz para o seu widget. Inicie uma nova reprodução apenas quando a anterior tiver terminado.
Visão geral
Chamada: POST /api/public/widget/voice-speak. Este endpoint pertence ao grupo «Widget de chat» da API da Zentor App. Requer um token de incorporação de widget válido. A chamada é idempotente: chamadas repetidas com os mesmos dados devolvem o mesmo resultado. Parâmetros obrigatórios: widget_code (body), text (body). Casos de erro documentados: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. A resposta de exemplo abaixo mostra a estrutura de uma resposta bem-sucedida em formato JSON.
Autenticação e segurança
Token de incorporação do widget (cabeçalho X-Widget-Token) + lista de origens permitidas
Idempotente: Sim
Parâmetros
widget_code(body, string, obrigatório)— Código do widget do seu código de incorporaçãotext(body, string, obrigatório)— Texto a lerResposta de exemplo
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}Códigos de erro
400 WIDGET_CODE_REQUIRED — O campo `widget_code` está em falta.503 VOICE_UNAVAILABLE — A função de voz não está ativada para este widget ou está atualmente indisponível.Comportamento verificado
Um `widget_code` em falta devolve 400 `WIDGET_CODE_REQUIRED`, um widget sem função de voz 503 `VOICE_UNAVAILABLE`. O caso de sucesso exige um widget com a função de voz ativada.
Widget de chat
GET /api/public/widget/healthVerificação simples de disponibilidade do serviço de widget.GET /api/public/widget/config/:widget_codeDevolve a configuração pública de um widget (nome de exibição, mensagem de boas-vindas, design, idioma, função de voz) para a inicialização no navegador.POST /api/public/widget/messageEnvia uma mensagem do visitante ao chatbot e devolve a sua resposta — o endpoint central do widget de chat.GET /api/public/widget/historyCarrega o histórico de mensagens anterior de uma conversa do widget, por exemplo após recarregar a página.POST /api/public/widget/pollObtém mensagens recebidas após um determinado momento — por exemplo, a resposta de um colaborador que assumiu a conversa.POST /api/public/widget/ratingGuarda a avaliação do visitante sobre uma conversa (útil ou não útil).POST /api/public/widget/trackRegista um evento anónimo de utilização do widget (por exemplo, «widget aberto») para as análises no painel.POST /api/public/widget/voice-transcribeConverte uma gravação de voz do visitante em texto (entrada de voz), se a função de voz estiver ativada para o widget.