Documentation › Outils › preview_campaign
preview_campaign
Contrôle les destinataires, les blocages, les doublons et tous les champs de chaque variante.
En bref
| Propriété | Valeur |
|---|---|
| Titre | Relire une campagne avant envoi |
| Outil MCP | preview_campaign, sur https://api.subagent.fr/mcp |
| Appel HTTP | POST https://api.subagent.fr/v1/preview_campaign |
| Accès | permission read |
| État de l’espace | vérifié ou non |
| Effet | lecture seule |
| Vue dans l’assistant | oui : voir Vues |
Ce que fait l’outil
Le serveur décrit l’outil ainsi à l’agent qui se branche :
Contrôle les destinataires, les blocages, les doublons et tous les champs de chaque variante. Retourne un aperçu personnalisé de chaque étape et variante, ainsi que les erreurs. Aucun envoi.
Paramètres
preview_campaign accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
campaign_id | identifiant cmp_… | oui | Campagne. |
offset | entier | non | De 0 à 100000. |
Résultat
L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.
| Champ | Type | Contenu |
|---|---|---|
blocked | liste | Les destinataires bloquants et la raison de chacun (champ vide, blocage, doublon). |
blocked_count | entier | Le nombre de destinataires bloquants. |
campaign | objet | Une campagne : id (cmp_…), name, status (draft, scheduled, running, paused, completed, stopped), archived, inbox_id, from_address, audience_id, reply_to, steps (de 1 à 4 étapes : delay_days et variants, chacune avec subject, text, html), starts_at, status_reason, source, previous (dans get_campaign : les étapes qu’une correction a remplacées, avec l’auteur et l’heure de la correction), created_at, updated_at. |
deferred | liste | Les départs différés et leur raison. |
deferred_count | entier | Le nombre de destinataires dont le départ sera différé. |
notice | texte | Ce qu’il faut relire avant de lancer. |
previews | liste | Un aperçu personnalisé de chaque étape et variante. |
ready | booléen | Rien ne bloque le lancement. |
recipients | entier | Le nombre de destinataires. |
revision | texte | L’empreinte de ce qui a été relu : à donner à campaign_action pour start. |
Exemple d’appel
Les valeurs sont fictives.
HTTP
curl -X POST https://api.subagent.fr/v1/preview_campaign \
-H "Authorization: Bearer $SUBAGENT_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaign_id": "cmp_6b2d9e41c7a84f03b5e1d28a90c4f7e3"
}'MCP · tools/call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "preview_campaign",
"arguments": {
"campaign_id": "cmp_6b2d9e41c7a84f03b5e1d28a90c4f7e3"
}
}
}Refus possibles
Aucun refus propre à cet outil. Restent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.