Envoyer un message avec l'API Front
Envoie un nouveau message depuis un canal, ce qui démarre une nouvelle conversation, et répond 202 avec un message_uid. Il part immédiatement, et Front archive la nouvelle conversation sauf si options.archive vaut false. Nécessite la permission d'envoi sur le jeton d'API.
- Identifiant
- front_send_message
L'appel
POST https://connect.reportei.com/api/tools/front_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"channel_id": "<channel_id>",
"to": [],
"body": "<body>"
}
}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 |
|---|---|---|---|
| channel_id | string | Oui | Channel that sends the message: the id starting with cha_ from List channels, or alt:address: followed by the channel address, like alt:address:support@acme.com. |
| to | array | Oui | Recipient handles, like email addresses or phone numbers, depending on the channel. |
| body | string | Oui | Body of the message. Email channels accept HTML. |
| cc | array | Non | Handles that get a copy. |
| bcc | array | Non | Handles that get a blind copy. |
| subject | string | Non | Subject, for email messages. |
| author_id | string | Non | Id of the teammate the message is sent on behalf of, starting with tea_, from List teammates. |
| options | object | Non | Tags to add and whether to archive the new conversation after sending. |
Connexions possibles
Votre client connecte son compte Front 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/front_send_message. Il devient la définition de tool de votre agent sans conversion.
Autres tools Front
- Rechercher des conversationsGETRecherche les conversations accessibles au jeton d'API, de l'activité la plus récente à la plus ancienne, et renvoie _total avec les correspondances. Les conversations à la corbeille sont exclues sauf si la requête demande is:trashed. La page suivante vient du page_token dans _pagination.next, qui vaut null sur la dernière page.
- Obtenir une conversationGETRenvoie une conversation avec son objet, son statut, son assigné, son destinataire principal, ses tags, ses champs personnalisés et ses liens. Les messages viennent de Lister les messages d'une conversation.
- Lister les messages d'une conversationGETListe les messages d'une conversation, les plus récents d'abord sauf si sort_order vaut asc, avec auteur, destinataires, objet, corps et détails des pièces jointes. La page suivante vient du page_token dans _pagination.next, qui vaut null sur la dernière page.
- Mettre à jour une conversationPATCHMet à jour l'assigné, la boîte, le statut, les tags ou les champs personnalisés d'une conversation. N'envoyez que les champs à modifier. tag_ids remplace tous les tags de la conversation ; pour ajouter des tags sans retirer les autres, utilisez Appliquer des tags.
- Appliquer des tagsPOSTAjoute un ou plusieurs tags à une conversation et conserve ceux qu'elle a déjà.
- Créer un commentairePOSTAjoute un commentaire interne à une conversation. Les commentaires ne sont vus que par les coéquipiers, jamais par le contact. Le corps accepte le Markdown.
- Créer un brouillonPOSTCrée un brouillon de réponse au dernier message d'une conversation, qu'un coéquipier relit et envoie dans Front. Rien n'est envoyé. Un brouillon privé n'est visible que par son auteur : définissez author_id sur le coéquipier qui le relira, ou utilisez le mode shared.
- Répondre à une conversationPOSTEnvoie immédiatement une réponse dans une conversation et répond 202 avec un message_uid. Front archive la conversation quand la réponse part, sauf si options.archive vaut false. Nécessite la permission d'envoi sur le jeton d'API. Une conversation fusionnée répond par une redirection vers la conversation dans laquelle elle a été fusionnée.
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.
