Su sistema llama a Whatsplaid para consultar capacidades, gestionar contactos, seguir conversaciones, enviar mensajes, controlar el agente de IA y solicitar atención humana.
API pública y documentación
Conecte sus sistemas a Whatsplaid con API, conectores y webhooks.
Utiliza la API pública para integrar contactos, conversaciones, mensajes, atención humana y el agente de IA. Usa el conector externo para consultar datos de tu sistema y webhooks para recibir eventos en tiempo real.
Tres contratos
Elija la dirección correcta de la integración.
La documentación de Swagger separa los flujos para evitar confusiones entre las llamadas a Whatsplaid, las consultas realizadas por el asistente y los eventos enviados a su sistema.
Whatsplaid llama a su sistema para consultar productos, pedidos, clientes o disponibilidad en tiempo real durante una conversación.
Conozca el conector externo vía APIWhatsplaid envía eventos de leads, mensajes, estados de entrega, tickets y cambios en el agente de IA a una URL configurada.
El Swagger en `api.whatsplaid.com/docs/` contiene los esquemas, ejemplos, respuestas esperadas y contratos técnicos completos.
Referencia rápida de los endpoints principales.
Esta vista resume las características que aparecen en la documentación oficial. La implementación final debe seguir el Swagger.
GET
/store
Devuelve datos de la cuenta, el comercio electrónico conectado y los módulos activos.
Account
GET
/capabilities
Indica qué operaciones están realmente disponibles según la cuenta, el plan, los módulos y las integraciones.
Account
GET
/ecommerce/products/search
Busca productos en las integraciones nativas conectadas, como Nuvemshop, Wix o Shopify.
Ecommerce
GET
/ecommerce/orders/search
Buscar pedidos por número, correo electrónico o teléfono en las integraciones nativas conectadas.
Ecommerce
POST
/contacts
Crea o actualiza un contacto usando el teléfono como clave principal.
Contacts
GET
/conversations
Lista de conversaciones iniciadas por los contactos, con paginación, ventana de respuesta y estado del agente de IA.
Conversations
GET
/conversations/{conversationId}/messages
Devuelve el historial de mensajes paginado de una conversación.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Actualiza campos personalizados para segmentación y contexto operativo.
Fields
POST
/messages/send
Envía un mensaje de texto dentro de la ventana de atención de 24 horas de WhatsApp.
Messaging
POST
/handoffs
Solicitar atención humana usando la configuración actual de la empresa.
Handoff
GET
/tickets
Lista de tickets de soporte humano con filtros y paginación.
Tickets
POST
/tickets/{ticketId}/close
Cierra el ticket, emite el evento correspondiente y reactiva el agente de IA de la conversación.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Activa o pausa el agente de IA solo para la conversación indicada.
Conversations
GET
/ai-agent/prompt
Consulta el prompt editable utilizado como instrucción base del agente de IA.
AI Agent
PATCH
/ai-agent/prompt
Actualiza el prompt editable con control de revisiones para evitar sobrescrituras concurrentes.
AI Agent
Contratos técnicos
La documentación cubre la API, el conector externo y los webhooks.
Los contratos separan las llamadas realizadas a Whatsplaid, las consultas que el agente hace en sistemas externos y los eventos enviados por Whatsplaid.
Consulta cuenta y capacidades, gestiona contactos, etiquetas y campos personalizados, supervisa conversaciones y envía mensajes dentro de la ventana permitida.
Consultar y actualizar el prompt editable, además de activar o pausar el agente por separado en cada conversación.
Accede al historial, la paginación, la ventana de respuesta de WhatsApp y el estado actual del agente de IA.
Su sistema puede exponer consultas de productos, pedidos, clientes y disponibilidad para el uso del agente durante la conversación.
Eventos disponibles: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` y `conversation.ai_agent.updated`.
Los webhooks utilizan `delivery_id` para la deduplicación y nuevos intentos en fallos temporales. La entrega se considera completa solo después de una respuesta HTTP 2xx.
¿Necesita implementar o validar una integración?
Abra la documentación interactiva para cambiar entre `Whatsplaid Public API`, `Custom Data Connector Contract` y `Outgoing Webhooks`.