Chat

La API de Chat permite que tu aplicación converse directamente con un agente de Platica. Puedes esperar la respuesta en el mismo ciclo HTTP o programar el turno para después.

Endpoints disponibles

MétodoEndpointDescripción
POST/v1/chat Iniciar una conversación o enviar el siguiente turno
GET/v1/chat Listar los chats del workspace
GET/v1/chat/{id} Obtener un chat con su historial de mensajes

Chat frente a Conversaciones

Ambos recursos operan sobre los mismos hilos, pero con responsabilidades distintas:

RecursoRolUso
/v1/chat Hablar como clienteEnviar texto o adjuntos al agente de inmediato o de forma programada.
/v1/conversations Administrar como negocioConsultar el inbox, asignar owners, cerrar, reabrir y auditar hilos.

Los chats creados por esta API también aparecen en los listados de Conversaciones . Para cerrar un chat, usa PATCH /v1/conversations/{id} con el status correspondiente.

Chat frente a Mensajes

Aunque ambos recursos intercambian texto, resuelven casos distintos:

RecursoUso
/v1/chat Tu aplicación habla con un agente de inmediato o programa el turno.
/v1/messages Tu negocio interviene una conversación existente o envía una instrucción al agente.

Usa Chat para experiencias dentro de tu producto, pruebas de agentes o integraciones backend a backend. Usa Mensajes cuando necesites comunicarte con un cliente a través de un canal conectado o intervenir un chat como negocio.

Ciclo de una conversación

  1. Inicia el hilo con agentId y un message, hasta 10 attachments, o ambos.
  2. Para programarlo, incluye delay o scheduleAt. La respuesta HTTP 202 no contiene mensajes del agente.
  3. Guarda id y conversationId: id es el documento canónico y conversationId es el hilo chat_*. Después de la hora programada, haz polling con GET /v1/chat/{id} o get_chat; puede responder 404 hasta que la tarea cree el documento.
  4. Continúa enviando el mismo conversationId. Si incluyes otro agentId, cambia el agente que responde sin perder el historial.
  5. Administra el hilo desde Conversaciones . Para cerrar una conversación exacta necesitas su id único, no el conversationId del chat.

Un chat cerrado o expirado conserva su historial y se reactiva automáticamente al recibir otro mensaje con el mismo conversationId. Para iniciar otro hilo, haz un POST /v1/chat sin conversationId. Cada solicitud nueva genera otro conversationId chat_<uuid>, aunque use el mismo clientId.

Anterior Eliminar Campo Personalizado Siguiente Enviar mensaje al agente