Point de terminaison

POST
api/whatsappcampaign/SendOperationalMessage


Documentation

Pour la documentation complète de l'API, voir :

https://webapi.mymarketing.co.il/api/docs/User/Api/POST-api-whatsappcampaign-SendOperationalMessage


À quoi il sert

Ce point de terminaison envoie un message WhatsApp opérationnel à partir d'un gabarit WhatsApp approuvé.

Statuts acceptés pour un message opérationnel : un message WhatsApp opérationnel peut être envoyé aux contacts de tous les statuts, sauf aux contacts non livrés. La même logique s'applique à l'e-mail, au SMS et à WhatsApp.

La gestion du lien de désinscription et la possibilité d'écrire à des contacts inactifs se règlent séparément dans l'interface.


Informations nécessaires

Avant d'envoyer un message, munissez-vous de :

1. L'identifiant du profil WhatsApp

Chaque compte peut avoir un ou plusieurs identifiants de profil WhatsApp. Quand le compte comporte plusieurs numéros ou expéditeurs WhatsApp, utilisez le whatsapp_profile_id correspondant au numéro depuis lequel envoyer ce message opérationnel.

Si vous ne connaissez pas le bon identifiant, contactez le support ActiveTrail.

Exemple :

"whatsapp_profile_id": 97

2. Le nom du gabarit

Le nom du gabarit doit exister dans votre compte.

Exemple :

"name": "template_name"

3. L'identifiant du gabarit

L'identifiant du gabarit se récupère avec :

GET
api/whatsappcampaign/templates

Ce point de terminaison renvoie tous les gabarits WhatsApp du compte.

Exemple :

"id": "HX3dc13e7a4bbedb8fae06d2b240de20c9"

4. Les variables dynamiques

Si le gabarit comporte des variables, transmettez leurs valeurs dans l'objet variables. Elles peuvent recevoir des valeurs de texte personnalisées transmises directement à l'envoi, et non plus seulement des valeurs issues des champs contact.

Exemple :

"variables": {
    "1": "12345"
}

Cela remplit la variable numéro 1 du gabarit WhatsApp.


Exemple de corps de requête

{
  "scheduling": {
    "is_sent": true
  },
  "segment": {
    "mobiles": [
      "+9725XXXXXXXX"
    ]
  },
  "details": {
    "whatsapp_profile_id": 97
  },
  "design": {
    "name": "template_name"
  },
  "template": {
    "id": "HX3dc13e7a4bbedb8fae06d2b240de20c9",
    "variables": {
      "1": "12345"
    }
  }
}

Description des champs

Champ

Description

scheduling.is_sent

Mettez-le à true pour envoyer immédiatement

segment.mobiles

Les numéros de mobile des destinataires, au format international

details.whatsapp_profile_id

L'identifiant de profil WhatsApp attribué au compte

design.name

Le nom du gabarit configuré dans le compte

template.id

L'identifiant du gabarit, récupéré avec GET api/whatsappcampaign/templates

template.variables

Les valeurs dynamiques des variables du gabarit


La marche à suivre habituelle

  1. Récupérez les gabarits disponibles avec :
    GET api/whatsappcampaign/templates

  2. Copiez ce dont vous avez besoin :

    • l'identifiant du gabarit ;

    • le nom du gabarit.

  3. Récupérez l'identifiant de profil WhatsApp du compte.

  4. Construisez le corps de la requête.

  5. Envoyez la requête à :
    POST api/whatsappcampaign/SendOperationalMessage

  6. Vérifiez la réponse de l'API.