Skip to main content
POST
Créer une campagne

Créer une campagne

Créez une nouvelle campagne d’envoi de messages WhatsApp en utilisant une liste de contacts existante.

Endpoint

Headers

string
requis
Bearer token avec votre Secret Key (format: Bearer sk_...)

Body Parameters

string
requis
Nom de la campagne
string
requis
Type de campagne: bulk_contacts, bulk_groups, individual
string
requis
ID de la liste de contacts à utiliser (Requis pour bulk_contacts)
array
requis
Tableau des IDs de profils WhatsApp à utiliser
array
requis
Variations de messages (spintax, A/B testing). Voir structure ci-dessous.
object
Délai entre messages: {min: 5, max: 10} (en secondes, défaut: 5-10s)
array
Fenêtres d’envoi: [{start: "09:00", end: "18:00"}] (défaut: 24h/24)
string
Timezone: Africa/Abidjan, Europe/Paris, etc. (défaut: UTC)
string
Date programmée (ISO 8601)

Structure de variations

Boutons dans les variations

Chaque variation text, image, video ou document peut contenir : Le spintax et les variables de contact sont traités dans buttons[].text, buttons[].url, buttons[].phoneNumber et footerText, comme dans content. Consultez Boutons interactifs pour les contraintes complètes.

Types de messages supportés

Variables de personnalisation

  • {{name}} - Nom du contact
  • {{phone}} - Numéro du contact
  • {{email}}, {{city}}, etc. - Toute colonne de votre liste de contacts

Spintax (variation de texte)

Utilisez {option1|option2|option3} pour générer des variations aléatoires : {Bonjour|Salut|Hello} {{name}} → génère différentes salutations. Cela permet d’éviter la détection de spam et rend chaque message unique.

Exemples de requêtes

Exemple de réponse

Notes importantes

  • listId requis : Pour type: bulk_contacts, le listId est obligatoire.
  • Statut automatique : Si listId est fourni, le statut sera ready (prêt à lancer).
  • Multiples profils : Rotation automatique entre les profils WhatsApp fournis.
  • Boutons facultatifs : Omettez buttons ou utilisez un tableau vide pour envoyer uniquement le message.

Codes d’erreur

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

application/json
name
string
type
enum<string>
Options disponibles:
bulk_contacts,
bulk_groups,
individual
listId
string
whatsappProfiles
string[]
variations
object[]
messageDelay
object
sendingWindows
object[]
timezone
string
scheduledAt
string

Réponse

OK