POST/api/public/widget/voice-speak
Convertit un texte en parole (sortie vocale dans le widget), si la fonction vocale est activée.
Envoyez `widget_code` et le texte à lire dans `text`. La réponse contient les données audio pour la lecture dans le navigateur. Pour une lecture directe via un élément `<audio>`, le même chemin est également disponible via GET. Si `widget_code` est manquant, le serveur répond 400 `WIDGET_CODE_REQUIRED` ; si la fonction vocale n'est pas activée ou est actuellement indisponible, 503 `VOICE_UNAVAILABLE`. Zentor configure la fonction vocale pour votre widget. Ne démarrez une nouvelle lecture qu'une fois la précédente terminée.
Vue d'ensemble
Appel : POST /api/public/widget/voice-speak. Ce point de terminaison appartient au groupe « Widget de chat » de l'API de Zentor App. Il nécessite un jeton d'intégration de widget valide. L'appel est idempotent : des appels répétés avec les mêmes données renvoient le même résultat. Paramètres obligatoires : widget_code (body), text (body). Cas d'erreur documentés : 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. L'exemple de réponse ci-dessous montre la structure d'une réponse réussie au format JSON.
Authentification et sécurité
Jeton d'intégration du widget (en-tête X-Widget-Token) + liste d'origines autorisées
Idempotent: Oui
Paramètres
widget_code(body, string, requis)— Code du widget provenant de votre code d'intégrationtext(body, string, requis)— Texte à lireExemple de réponse
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}Codes d'erreur
400 WIDGET_CODE_REQUIRED — Le champ `widget_code` est manquant.503 VOICE_UNAVAILABLE — La fonction vocale n'est pas activée pour ce widget ou est actuellement indisponible.Comportement vérifié
Un `widget_code` manquant renvoie 400 `WIDGET_CODE_REQUIRED`, un widget sans fonction vocale 503 `VOICE_UNAVAILABLE`. Le cas de succès requiert un widget avec la fonction vocale activée.
Widget de chat
GET /api/public/widget/healthVérification simple de disponibilité du service de widget.GET /api/public/widget/config/:widget_codeFournit la configuration publique d'un widget (nom d'affichage, message de bienvenue, design, langue, fonction vocale) pour l'initialisation dans le navigateur.POST /api/public/widget/messageEnvoie un message du visiteur au chatbot et renvoie sa réponse – le point de terminaison central du widget de chat.GET /api/public/widget/historyCharge l'historique des messages précédents d'une conversation du widget, par exemple après le rechargement de la page.POST /api/public/widget/pollRécupère les messages reçus après un instant donné – par exemple la réponse d'un collaborateur ayant repris la conversation.POST /api/public/widget/ratingEnregistre l'évaluation du visiteur sur une conversation (utile ou non utile).POST /api/public/widget/trackEnregistre un événement d'utilisation anonyme du widget (p. ex. « widget ouvert ») pour les analyses dans le tableau de bord.POST /api/public/widget/voice-transcribeConvertit un enregistrement vocal du visiteur en texte (saisie vocale), si la fonction vocale est activée pour le widget.