POST/api/global-chatbot/demo/voice-speak

Converte texto em voz (saída de voz na página de demonstração), se a funcionalidade de voz da demonstração estiver ativada.

Envie `visitor_id` (UUID) e o texto a ler em `text`. A resposta contém os dados de áudio para reprodução; para um elemento `<audio>`, o mesmo caminho está também disponível via GET. O endpoint corresponde a `POST /api/public/widget/voice-speak`, mas está associado à demonstração em zentor-app.de e não se destina a ser uma interface geral de texto para voz. Casos de erro: 400 `INVALID_VISITOR_ID` (UUID em falta ou inválido), 403 `ORIGIN_DENIED` (chamada não proveniente de zentor-app.de) e 503 `VOICE_UNAVAILABLE` (funcionalidade de voz atualmente indisponível).

Visão geral

Chamada: POST /api/global-chatbot/demo/voice-speak. Este endpoint pertence ao grupo «Chatbot de demonstração e SSO» da API da Zentor App. É de acesso público e não requer autenticação. A chamada é idempotente: chamadas repetidas com os mesmos dados devolvem o mesmo resultado. Parâmetros obrigatórios: visitor_id (body), text (body). Casos de erro documentados: 400 INVALID_VISITOR_ID, 403 ORIGIN_DENIED, 503 VOICE_UNAVAILABLE. A resposta de exemplo abaixo mostra a estrutura de uma resposta bem-sucedida em formato JSON.

Autenticação e segurança

Não é necessária autenticação

Só aceita chamadas de https://zentor-app.de e https://www.zentor-app.de; não é necessário token de incorporação para a demonstração.

Idempotente: Sim

Parâmetros

visitor_id(body, string, obrigatório)— ID do visitante, deve ser um UUID válido
text(body, string, obrigatório)— Texto a ler em voz alta

Resposta de exemplo

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}

Códigos de erro

400 INVALID_VISITOR_ID — `visitor_id` está em falta ou não é um UUID válido.
403 ORIGIN_DENIED — A chamada não provém de zentor-app.de.
503 VOICE_UNAVAILABLE — A funcionalidade de voz está atualmente indisponível.

Comportamento verificado

Um `visitor_id` inválido devolve 400 `INVALID_VISITOR_ID`, uma funcionalidade de voz indisponível devolve 503 `VOICE_UNAVAILABLE`. O caso de sucesso só é possível a partir de zentor-app.de.

Chatbot de demonstração e SSO

POST /api/global-chatbot/demoEnvia uma mensagem para o chatbot de demonstração público em zentor-app.de/demo e devolve a sua resposta. A demonstração pode ser testada no navegador sem registo.GET /api/global-chatbot/demo/historyCarrega o histórico de mensagens de uma conversa de demonstração para que seja preservado ao reabrir a demonstração.POST /api/global-chatbot/demo/pollObtém novas mensagens de uma conversa de demonstração, por exemplo quando um colaborador da Zentor assumiu a conversa. A página de demonstração chama o endpoint em intervalos.POST /api/global-chatbot/demo/ratingGuarda a avaliação de uma conversa de demonstração (útil ou não útil) com um comentário opcional.POST /api/global-chatbot/demo/trackRegista eventos de utilização anónimos da página de demonstração para as estatísticas de visitantes da Zentor.POST /api/global-chatbot/demo/voice-transcribeConverte uma gravação de voz na página de demonstração em texto (entrada de voz), se a funcionalidade de voz da demonstração estiver ativada.GET /api/sso/:tenantSlug/statusVerifica se o início de sessão único (SAML ou OIDC) está configurado para uma conta. A página de autenticação utiliza o resultado para oferecer o início de sessão SSO.GET /api/sso/:tenantSlug/oidc/startInicia o início de sessão via OpenID Connect e redireciona o navegador para o fornecedor de identidade configurado.GET /api/sso/:tenantSlug/oidc/callbackRecebe o redirecionamento do fornecedor de identidade após o início de sessão OIDC e redireciona o navegador de volta para a Zentor App.GET /api/sso/:tenantSlug/saml/startInicia o início de sessão via SAML e redireciona o navegador para o fornecedor de identidade configurado.POST /api/sso/:tenantSlug/saml/acsAssertion Consumer Service (ACS): recebe a resposta SAML assinada do fornecedor de identidade através de um POST de formulário.GET /api/sso/:tenantSlug/saml/metadataDevolve os metadados SAML da Zentor App (XML) para importação no seu fornecedor de identidade.

Artigos relacionados

← Chatbot de demonstração e SSO