Votre système appelle Whatsplaid pour consulter les capacités, gérer les contacts, suivre les conversations, envoyer des messages, contrôler l'agent IA et demander une assistance humaine.
API publique et documentation
Connectez vos systèmes à Whatsplaid avec des API, des connecteurs et des webhooks.
Utilisez l'API publique pour intégrer les contacts, conversations, messages, support humain et l'agent IA. Utilisez le connecteur externe pour interroger les données de votre système et les webhooks pour recevoir les événements en temps réel.
Trois contrats
Choisissez le sens correct de l’intégration.
La documentation Swagger sépare les flux afin d'éviter toute confusion entre les appels à Whatsplaid, les requêtes effectuées par l'assistant et les événements envoyés à votre système.
Whatsplaid appelle votre système pour interroger des produits, commandes, clients ou la disponibilité en temps réel lors d’une conversation.
Découvrez le connecteur externe via APIWhatsplaid envoie des événements de leads, des messages, des statuts de livraison, des tickets et des modifications de l'agent IA vers une URL configurée.
Le Swagger à `api.whatsplaid.com/docs/` contient les schémas, exemples, réponses attendues et contrats techniques complets.
Référence rapide des principaux endpoints.
Cette vue résume les fonctionnalités apparaissant dans la documentation officielle. L’implémentation finale doit suivre le Swagger.
GET
/store
Renvoie les données du compte, le commerce électronique connecté et les modules actifs.
Account
GET
/capabilities
Indique quelles opérations sont réellement disponibles en fonction du compte, du plan, des modules et des intégrations.
Account
GET
/ecommerce/products/search
Recherchez des produits dans les intégrations natives connectées, telles que Nuvemshop, Wix ou Shopify.
Ecommerce
GET
/ecommerce/orders/search
Rechercher des commandes par numéro, e‑mail ou téléphone dans les intégrations natives connectées.
Ecommerce
POST
/contacts
Crée ou met à jour un contact en utilisant le téléphone comme clé principale.
Contacts
GET
/conversations
Liste des conversations initiées par les contacts, avec pagination, fenêtre de réponse et état de l'agent IA.
Conversations
GET
/conversations/{conversationId}/messages
Renvoie l'historique paginé des messages d'une conversation.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Met à jour les champs personnalisés pour le ciblage et le contexte opérationnel.
Fields
POST
/messages/send
Envoie un message texte dans la fenêtre de prise en charge de 24 heures de WhatsApp.
Messaging
POST
/handoffs
Demander une assistance humaine en utilisant la configuration actuelle de l’entreprise.
Handoff
GET
/tickets
Liste des tickets d'assistance humaine avec filtres et pagination.
Tickets
POST
/tickets/{ticketId}/close
Clôt le ticket, émet l'événement correspondant et réactive l'agent IA de la conversation.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Active ou met en pause l'agent IA uniquement pour la conversation indiquée.
Conversations
GET
/ai-agent/prompt
Consulta l'invite modifiable utilisée comme instruction de base de l'agent IA.
AI Agent
PATCH
/ai-agent/prompt
Mets à jour l'invite modifiable avec un contrôle de révision pour éviter les écrasements concurrents.
AI Agent
Contrats techniques
La documentation couvre l’API, le connecteur externe et les webhooks.
Les contrats séparent les appels effectués vers Whatsplaid, les requêtes effectuées par l'agent dans des systèmes externes et les événements envoyés par Whatsplaid.
Consulte le compte et les capacités, gère les contacts, les tags et les champs personnalisés, suit les conversations et envoie des messages dans la fenêtre autorisée.
Consulter et mettre à jour l’invite modifiable, et activer ou mettre en pause l’agent séparément dans chaque conversation.
Accède à l'historique, à la pagination, à la fenêtre de réponse WhatsApp et à l'état actuel de l'agent IA.
Votre système peut exposer des requêtes sur les produits, les commandes, les clients et la disponibilité pour l'utilisation par l'agent pendant la conversation.
Événements disponibles : `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` et `conversation.ai_agent.updated`.
Les webhooks utilisent `delivery_id` pour la déduplication et les nouvelles tentatives en cas d'échecs temporaires. La livraison n'est considérée comme terminée qu'après une réponse HTTP 2xx.
Besoin d’implémenter ou de valider une intégration ?
Ouvrez la documentation interactive pour basculer entre `Whatsplaid Public API`, `Custom Data Connector Contract` et `Outgoing Webhooks`.