POST/api/public/widget/voice-speak

Convierte texto en voz hablada (salida de voz en el widget), si la función de voz está activada.

Envíe `widget_code` y el texto a leer en `text`. La respuesta contiene los datos de audio para la reproducción en el navegador. Para la reproducción directa mediante un elemento `<audio>`, la misma ruta también está disponible por GET. Si falta `widget_code`, el servidor responde 400 `WIDGET_CODE_REQUIRED`; si la función de voz no está activada o actualmente no está disponible, 503 `VOICE_UNAVAILABLE`. Zentor configura la función de voz para su widget. Inicie una nueva reproducción solo cuando haya terminado la anterior.

Descripción general

Llamada: POST /api/public/widget/voice-speak. Este endpoint pertenece al grupo «Widget de chat» de la API de Zentor App. Requiere un token de inserción de widget válido. La llamada es idempotente: las llamadas repetidas con los mismos datos devuelven el mismo resultado. Parámetros obligatorios: widget_code (body), text (body). Casos de error documentados: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. La respuesta de ejemplo siguiente muestra la estructura de una respuesta correcta en formato JSON.

Autenticación y seguridad

Token de inserción del widget (cabecera X-Widget-Token) + lista de orígenes permitidos

Idempotente: Sí

Parámetros

widget_code(body, string, obligatorio)— Código del widget de su código de inserción
text(body, string, obligatorio)— Texto a leer

Respuesta de ejemplo

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

Códigos de error

400 WIDGET_CODE_REQUIRED — Falta el campo `widget_code`.
503 VOICE_UNAVAILABLE — La función de voz no está activada para este widget o actualmente no está disponible.

Comportamiento verificado

Un `widget_code` faltante devuelve 400 `WIDGET_CODE_REQUIRED`, un widget sin función de voz 503 `VOICE_UNAVAILABLE`. El caso de éxito requiere un widget con la función de voz activada.

Widget de chat

GET /api/public/widget/healthComprobación sencilla de disponibilidad del servicio de widget.GET /api/public/widget/config/:widget_codeDevuelve la configuración pública de un widget (nombre visible, mensaje de bienvenida, diseño, idioma, función de voz) para la inicialización en el navegador.POST /api/public/widget/messageEnvía un mensaje del visitante al chatbot y devuelve su respuesta — el endpoint central del widget de chat.GET /api/public/widget/historyCarga el historial de mensajes previo de una conversación del widget, por ejemplo tras recargar la página.POST /api/public/widget/pollObtiene los mensajes recibidos después de un momento dado, por ejemplo la respuesta de un empleado que ha asumido la conversación.POST /api/public/widget/ratingGuarda la valoración del visitante sobre una conversación (útil o no útil).POST /api/public/widget/trackRegistra un evento anónimo de uso del widget (p. ej., «widget abierto») para los análisis en el panel.POST /api/public/widget/voice-transcribeConvierte una grabación de voz del visitante en texto (entrada de voz), si la función de voz está activada para el widget.

Artículos relacionados

← Widget de chat