Obtenir une conversation avec l'API Crisp
Renvoie une conversation avec son état, l'opérateur assigné, les compteurs de non-lus, le dernier message, le people_id du contact et le meta du visiteur. Les messages viennent de Lister les messages de la conversation.
- Identifiant
- crisp_get_conversation
L'appel
POST https://connect.reportei.com/api/tools/crisp_get_conversation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"website_id": "<website_id>",
"session_id": "<session_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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| website_id | string | Oui | Id of the workspace, from List websites. |
| session_id | string | Oui | Id of the conversation, starting with session_, from List conversations. |
Connexions possibles
Votre client connecte son compte Crisp une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie 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/crisp_get_conversation. Il devient la définition de tool de votre agent sans conversion.
Autres tools Crisp
- Lister les websitesGETListe les workspaces Crisp, appelés websites dans l'API, où le plugin de ce jeton est installé, avec leur website_id. Obtenir un website donne le nom de chacun. Les pages commencent à 1, et une liste data vide signifie qu'il n'y a plus de pages.
- Obtenir un websiteGETRenvoie le nom, le domaine et le logo d'un workspace Crisp, pour distinguer les ids que renvoie Lister les websites.
- Lister les conversationsGETListe les conversations d'un workspace, avec session_id, state, compteurs de non-lus, opérateur assigné, dernier message et le meta du visiteur (nickname, email, phone, segments). Les pages commencent à 1, et une page avec moins d'éléments que per_page est la dernière.
- Lister les messages d'une conversationGETRenvoie le dernier lot de messages d'une conversation, avec type, sender, content et timestamp en millisecondes. Pour paginer vers les messages plus anciens, envoyez le timestamp du plus ancien message du lot comme timestamp_before.
- Envoyer un messagePOSTEnvoie un message en tant qu'opérateur dans une conversation. Le type text part tout de suite au visiteur ; le type note est une note interne vue seulement par les opérateurs.
- Modifier l'état d'une conversationPATCHChange l'état d'une conversation en pending, unresolved ou resolved.
- Assigner une conversationPATCHAssigne une conversation à un opérateur, qui est notifié sauf si silent vaut true.
- Modifier le meta d'une conversationPATCHMet à jour les informations du visiteur et le sujet ou les segments d'une conversation. N'envoyez que les champs à modifier.
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.
