GET/api/public/widget/history

Carga el historial de mensajes previo de una conversación del widget, por ejemplo tras recargar la página.

Pase `widget_code`, `session_id` y `visitor_id` como parámetros de consulta. La respuesta contiene, en el objeto `data`, la lista `messages` con `role` (`user` o `assistant`), `text` y `created_at` en el orden de la conversación. La llamada es de solo lectura e idempotente. El encabezado `X-Widget-Token` con el token de inserción y `widget_code` son obligatorios. Si falta el token, el servidor responde 401 `WIDGET_TOKEN_MISSING`; si es inválido, 401 `WIDGET_TOKEN_INVALID`; las llamadas desde dominios no autorizados reciben 403 `WIDGET_ORIGIN_DENIED`, y un widget desactivado, 404 `WIDGET_DISABLED`. Si faltan `session_id` o `visitor_id`, el servidor responde 400 `PARAMS_REQUIRED`. Si la sesión ya no se conoce, inicie una nueva conversación.

Descripción general

Llamada: GET /api/public/widget/history. 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 (query), session_id (query), visitor_id (query). Casos de error documentados: 400 PARAMS_REQUIRED. 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(query, string, obligatorio)— Código del widget de su código de inserción
session_id(query, string, obligatorio)— ID de sesión de la conversación de la respuesta de `message`
visitor_id(query, string, obligatorio)— ID de visitante generado por el widget y almacenado en el navegador

Respuesta de ejemplo

{"ok":true,"data":{"messages":[{"role":"user","text":"Hola...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}

Códigos de error

400 PARAMS_REQUIRED — Falta `session_id` o `visitor_id`.

Comportamiento verificado

Una sesión existente devuelve 200 con el historial de mensajes; los parámetros faltantes devuelven 400 `PARAMS_REQUIRED`.

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.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.POST /api/public/widget/voice-speakConvierte texto en voz hablada (salida de voz en el widget), si la función de voz está activada.

Artículos relacionados

← Widget de chat