Créer un message avec l'API Chatwoot
Envoie un message dans une conversation. Un message sortant arrive au contact par le canal de la boîte, comme WhatsApp, email ou le widget du site ; private true crée une note interne que seuls les agents voient. Sur WhatsApp, template_params envoie un template approuvé.
- Identifiant
- chatwoot_create_message
L'appel
POST https://connect.reportei.com/api/tools/chatwoot_create_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": 1,
"conversation_id": 1,
"content": "<content>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| account_id | integer | Oui | Id of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123. |
| conversation_id | integer | Oui | Id of the conversation, from List conversations. |
| content | string | Oui | Text of the message. With a template, the rendered text of the template. |
| message_type | string | Non | outgoing is a message to the contact; incoming records a message as sent by the contact.Valeurs : outgoing, incoming |
| private | boolean | Non | true makes the message an internal note, not sent to the contact. |
| template_params | object | Non | WhatsApp template approved in WhatsApp Business Manager. |
Connexions possibles
Votre client connecte son compte Chatwoot une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/chatwoot_create_message. Il devient la définition de tool de votre agent sans conversion.
Autres tools Chatwoot
- Lister les conversationsGETListe les conversations d'un compte, par défaut les ouvertes, avec statut, étiquettes, inbox_id, can_reply, le contact dans meta.sender, l'assigné et le dernier message. data.meta contient les compteurs par type d'assigné. Les pages commencent à 1 ; un payload vide signifie qu'il n'y a plus de pages.
- Créer une conversationPOSTDémarre une conversation avec un contact dans une boîte, éventuellement avec un premier message. source_id identifie le contact dans cette boîte : il vient de contact_inboxes dans Search contacts, de Create contact ou de Create contact inbox. Dans les boîtes WhatsApp, le premier message part comme template approuvé dans message.template_params.
- Mettre à jour le statut d'une conversationPOSTDéfinit le statut d'une conversation : open, resolved, pending ou snoozed. Sans snoozed_until, une conversation en snoozed attend la prochaine réponse du contact, et toute réponse du contact la rouvre.
- Assigner une conversationPOSTAssigne une conversation à un agent ou à une équipe. Quand assignee_id est envoyé, team_id est ignoré.
- Mettre à jour les étiquettes d'une conversationPOSTDéfinit les étiquettes d'une conversation. La liste envoyée remplace les étiquettes actuelles : elle doit donc inclure celles à conserver.
- Lister les messagesGETRenvoie les derniers messages d'une conversation dans l'ordre croissant, avec meta contenant étiquettes, contact et assigné. sender_type indique qui a envoyé chaque message, et private marque les notes internes. Pour des messages plus anciens, passez before avec l'id du plus ancien reçu.
- Rechercher des contactsGETRecherche les contacts qui ont un identifiant, un email ou un téléphone, par nom, identifiant, email ou numéro de téléphone, 15 par page. Chaque contact a contact_inboxes, qui associe chaque boîte au source_id dont Create conversation a besoin. meta.count est le total ; une page de moins de 15 contacts est la dernière.
- Créer un contactPOSTCrée un contact dans une boîte du compte. La réponse contient le contact et le contact_inbox avec le source_id dont Create conversation a besoin.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
