Aller au contenu

Ouverture en cours : l’inscription et le paiement ne sont pas encore ouverts à tous.

subagentdocs
Sommaire de la documentation

Documentation › Outils › cancel_message

cancel_message

Voir en .md

Annule un brouillon ou un message encore en file : il ne partira pas.

En bref

PropriétéValeur
TitreAnnuler un message
Outil MCPcancel_message, sur https://api.subagent.fr/mcp
Appel HTTPPOST https://api.subagent.fr/v1/cancel_message
Accèspermission send ou approve
État de l’espacevérifié ou non
Effetécriture
Vue dans l’assistantnon

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Annule un brouillon ou un message encore en file : il ne partira pas. Un message déjà parti ne se rappelle pas.

Paramètres

cancel_message accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.

ParamètreTypeObligatoireDescription
message_ididentifiant msg_…ouiLe message (msg_…).
reasontextenonPourquoi, pour le journal. 300 caractères au plus.

Résultat

L’outil rend un message. L’objet structuré déclare les champs ci-dessous ; la page de concept les décrit tous : voir les champs d’un message.

ChampTypeContenu
auto_replybooléenRéponse automatique (absence…).
created_attexteISO 8601.
directiontexteoutbound : sortant ; inbound : entrant.
fromtexteExpéditeur.
has_htmlbooléenLe message a une version HTML.
idtexteIdentifiant du message (msg_…).
inbox_idtexteBoîte du message.
received_attexte ou nullLa date de réception d’un message entrant (ISO 8601), sinon null.
reply_totexte ou nullAdresse de réponse, si elle diffère de la boîte.
revisiontexteVersion du message : change à chaque modification (voir approve_message).
sent_attexte ou nullLa date du départ (ISO 8601), sinon null.
statustexteLe statut du message. Valeurs : draft, queued, sending, sent, delivered, bounced, failed, rejected, cancelled, received.
status_codetexte ou nullCode stable d’un refus ou d’un échec.
subjecttexteSujet.
texttexteTexte (lecture d’un message ou d’un fil).
thread_idtexteFil du message.
totexteDestinataire.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/cancel_message \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message_id": "msg_7f2a91c4e8b34d0fa6c25e1b9d3f7a48",
  "reason": "Rendez-vous déjà déplacé par téléphone"
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cancel_message",
    "arguments": {
      "message_id": "msg_7f2a91c4e8b34d0fa6c25e1b9d3f7a48",
      "reason": "Rendez-vous déjà déplacé par téléphone"
    }
  }
}

Refus possibles

CodeHTTPCe qui s’est passéQue faire
not_found404L’objet n’existe pas pour cette clé.Vérifier l’identifiant : il vient de list_inboxes, list_threads, get_thread ou list_drafts.
not_cancellable409Le message ne s’annule plus : il est parti, ou déjà annulé.Rien : un message parti ne se rappelle pas.

S’y ajoutent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

Voir aussi

Cette page en Markdown : /docs/reference/cancel_message.md Toute la documentation pour un agent : /llms.txt Mentions légales · Conditions de vente · Confidentialité · Signaler un abus