Créer un message avec l'API Intercom
Envoie un nouveau message d'un membre de l'équipe à un contact, dans le Messenger (in_app) ou par email. L'email exige subject et template. La conversation n'existe qu'après la réponse du contact, sauf si create_conversation_without_contact_reply est true.
- Identifiant
- intercom_create_message
L'appel
POST https://connect.reportei.com/api/tools/intercom_create_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"message_type": "in_app",
"body": "<body>",
"from": {},
"to": {}
}
}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 |
|---|---|---|---|
| message_type | string | Oui | in_app shows the message in the Messenger; email sends it by email.Valeurs : in_app, email |
| subject | string | Non | Subject of the email. Required with email. |
| body | string | Oui | Content of the message, as HTML or plain text. |
| template | string | Non | Style of the email, plain or personal. Required with email. |
| from | object | Oui | The teammate who sends the message. |
| to | object | Oui | The contact who receives the message. |
| create_conversation_without_contact_reply | boolean | Non | true opens the conversation in the inbox right away, without waiting for the contact to reply. The default is false. |
Connexions possibles
Votre client connecte son compte Intercom une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/intercom, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
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/intercom_create_message. Il devient la définition de tool de votre agent sans conversion.
Autres tools Intercom
- Lister les contactsGETListe les contacts du workspace, utilisateurs et leads, 10 par page par défaut. La page suivante vient de pages.next.starting_after dans la réponse ; sans lui, c'est la dernière page. Les contacts fusionnés n'apparaissent pas.
- Rechercher des contactsPOSTRecherche des contacts par leurs attributs, par exemple par email, role ou un attribut personnalisé. Les timestamps sont en secondes Unix UTC. Renvoie total_count et data, 50 par page par défaut, et la page suivante vient de pages.next.starting_after. Un contact créé ces dernières minutes peut ne pas encore apparaître.
- Obtenir un contactGETRenvoie un contact avec role, email, téléphone, nom, owner_id, custom_attributes, tags, entreprises et localisation. Un contact fusionné dans un autre renvoie 410.
- Créer un contactPOSTCrée un contact, utilisateur ou lead. Envoyez au moins un parmi email, external_id ou role. Chaque attribut personnalisé envoyé doit déjà exister dans le workspace, sinon Intercom refuse le contact.
- Mettre à jour un contactPUTMet à jour un contact : envoyez seulement les champs à modifier. Un utilisateur ne peut pas devenir lead. Chaque attribut personnalisé envoyé doit déjà exister dans le workspace.
- Lister les conversationsGETListe les conversations du workspace, 20 par page par défaut. La page suivante vient de pages.next.starting_after dans la réponse ; sans lui, c'est la dernière page. Obtenir une conversation renvoie toutes les parties d'une conversation.
- Rechercher des conversationsPOSTRecherche des conversations par leurs attributs, par exemple les ouvertes assignées à un membre de l'équipe ou à une équipe. Les timestamps sont en secondes Unix. Renvoie total_count et conversations, 20 par page par défaut, et la page suivante vient de pages.next.starting_after.
- Obtenir une conversationGETRenvoie une conversation avec ses parties (messages, notes et actions), jusqu'aux 500 plus récentes, plus state, assignés, contacts et tags.
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.
