Créer une conversation avec l'API Chatwoot

Dé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.

Identifiant
chatwoot_create_conversation

L'appel

POST https://connect.reportei.com/api/tools/chatwoot_create_conversation/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,
    "source_id": "<source_id>"
  }
}

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ètreTypeObligatoireDescription
account_idintegerOuiId 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.
source_idstringOuisource_id of the contact in the inbox, from contact_inboxes of Search contacts, Create contact or Create contact inbox. Each item pairs an inbox with its source_id.
inbox_idintegerNonInbox of the conversation, the same of the source_id, from List inboxes.
contact_idintegerNonId of the contact, from Search contacts.
statusstringNonInitial status of the conversation.Valeurs : open, resolved, pending
assignee_idintegerNonId of the agent to assign, from List agents.
team_idintegerNonId of the team to assign, from List teams.
custom_attributesobjectNonConversation custom attribute values keyed by attribute key.
messageobjectNonFirst message of the conversation, sent to the contact.

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_conversation. Il devient la définition de tool de votre agent sans conversion.

Autres tools Chatwoot

Voir les 15 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.