Passer au contenu principal

Endpoint

GET /api/v1/campaigns/{id}

Paramètres path

NomTypeRequisDescription
idUUIDouiID de la campagne

Réponse succès 200

{
  "data": {
    "id": "cmp_uuid",
    "userId": "user_uuid",
    "name": "Promo Black Friday",
    "instanceId": "inst_uuid",
    "templateId": null,
    "type": "image",
    "body": "Découvrez notre offre",
    "mediaUrl": "https://cdn.example.com/promo.jpg",
    "schedule": "2026-04-02T10:00:00.000Z",
    "repeat": "none",
    "status": "running",
    "recipients": { "type": "all" },
    "templateVariables": null,
    "stats": {
      "planned": 500,
      "queued": 120,
      "sent": 350,
      "delivered": 330,
      "read": 210,
      "failed": 30,
      "cancelled": 0,
      "processingStartedAt": "2026-04-02T10:00:01.000Z",
      "lastEnqueuedAt": "2026-04-02T10:03:20.000Z",
      "completedAt": null,
      "cancelledAt": null
    },
    "createdAt": "2026-04-01T17:00:00.000Z",
    "updatedAt": "2026-04-02T10:03:20.000Z"
  }
}

Lecture du contenu

  • si templateId est présent : la campagne est en mode template
  • sinon si type est présent : la campagne est en mode message direct
  • body et mediaUrl peuvent alors être affichés dans le détail

Erreurs courantes

HTTPCodeQuand
404NOT_FOUNDCampagne introuvable