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ètreTypeObligatoireDescription
channel_idstringOuiChannel 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.
toarrayOuiRecipient handles, like email addresses or phone numbers, depending on the channel.
bodystringOuiBody of the message. Email channels accept HTML.
ccarrayNonHandles that get a copy.
bccarrayNonHandles that get a blind copy.
subjectstringNonSubject, for email messages.
author_idstringNonId of the teammate the message is sent on behalf of, starting with tea_, from List teammates.
optionsobjectNonTags 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

Voir les 13 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.