Aller au contenu
Prescriptio
ConnexionS’inscrire
Parcourir la documentation

REST : campagnes e-mail

Lire une campagne

L'opération REST email.campaigns.get de Prescriptio sert à lire une campagne, ses messages, ses liens, son calendrier et ses résultats.

Voir en MarkdownConnecter mon agent IA
POST/api/mcp/v1/email.campaigns.get

POST /api/mcp/v1/email.campaigns.get, portée mcp:read; droits, conditions d’offre et quotas contrôlés par l’action. Même traitement que l'outil campagne_email.

exemple synthétique
curl -sS https://prescriptio.fr/api/mcp/v1/email.campaigns.get \
  -H 'Authorization: Bearer <jeton>' \
  -H 'Content-Type: application/json' \
  -d '{"campagne_id":"00000000-0000-0000-0000-000000000001"}'
Réponsegénérée depuis le schéma
{
  "action": "<campagne_lue>",
  "fields": {
    "calendrier": [
      {
        "clics": 0,
        "email": "<texte>",
        "entreprise_cle": "<texte>",
        "envoye_le": "<texte>",
        "erreur": "<texte>",
        "fonction": "<texte>",
        "id": "<texte>",
        "livraison": "<texte>",
        "mode": "<texte>",
        "nom": "<texte>",
        "ouvertures": 0,
        "palier": 0,
        "personnalisation": {},
        "planifie_le": "<texte>",
        "prenom": "<texte>",
        "rang": 0,
        "societe": "<texte>",
        "source": "<texte>",
        "statut": "<texte>",
        "variante": "<texte>",
        "ville": "<texte>"
      }
    ],
    "campagne": {
      "cree_le": "<texte>",
      "demarre_le": "<texte>",
      "equipe_jours": 0,
      "expediteur": "<texte>",
      "expediteur_etat": "<texte>",
      "expediteur_nom": "<texte>",
      "id": "<texte>",
      "nom": "<texte>",
      "organisation_nom": "<texte>",
      "relance_jours": 0,
      "relances_max": 0,
      "repondre_a": "<texte>",
      "statut": "<texte>"
    },
    "champs_disponibles": [
      "<texte>"
    ],
    "champs_sans_valeur": [
      {
        "champ": "<texte>",
        "manquants": 0
      }
    ],
    "liens": [
      {
        "idx": 0,
        "libelle": "<texte>",
        "url": "<texte>"
      }
    ],
    "stats": {
      "annules": 0,
      "clics": 0,
      "contacts_ayant_clique": 0,
      "desinscrits": 0,
      "destinataires": 0,
      "echecs": 0,
      "en_journal": 0,
      "envoyes": 0,
      "planifies": 0,
      "repondus": 0
    },
    "suivi": [
      {
        "campagne_id": "<texte>",
        "contacts_ayant_ouvert": 0,
        "livraisons": [
          {
            "nombre": null,
            "statut": null
          }
        ]
      }
    ],
    "variantes": [
      {
        "contenu": {},
        "corps": "<texte>",
        "etiquette": "<texte>",
        "format": "<texte>",
        "id": "<texte>",
        "objet": "<texte>",
        "ordre": 0
      }
    ]
  },
  "note": "<texte>",
  "ok": null,
  "url": "<texte>"
}

Paramètres du corps

campagne_idtexterequis
UUID de la campagne. Requis partout sauf lister, creer, stats (global), desinscrits, expediteur et quota.

En bref

Adresse
POST /api/mcp/v1/email.campaigns.get
Contrat
3.0.0
Portée OAuth
mcp:read
Conditions d’accès
Chaque action conserve ses droits, ses conditions d’offre et ses quotas ; sa présence dans le catalogue ne les lève pas.
Outil MCP
campagne_email : même traitement

Erreurs et quotas

Cet outil ne consomme aucune unité de dossier : chercher est gratuit, c'est la lecture d'un dossier (marches_dce, mairies_deliberations et leurs téléchargements) qui est décomptée.

Les codes HTTP, le corps d’erreur et les compteurs d’appels et de dossiers sont communs. Chaque action conserve aussi ses droits et plafonds métier : Codes d'erreur et Authentification et quotas.

Les pages qui s'en servent

Calculé depuis la documentation : chaque page qui cite email.campaigns.get.

Voir aussi

Cette page vous a-t-elle aidé ?Envoyer un retour

Voir tous les résultats

Préparer une conversation

Copiez le contexte de cette page, puis collez-le dans votre assistant.

Voir le contexte à transmettre
Ouvrir ClaudeOuvrir ChatGPT