API WhatsApp

createWhatsAppMessage

Utilisé pour envoyer des messages WhatsApp aux utilisateurs

POST https://api.pushwoosh.com/json/1.3/createWhatsAppMessage

Corps de la requête

Nom	Requis	Type	Description
auth*	Oui	string	Jeton d’accès API depuis le Panneau de configuration de Pushwoosh.
application*	Oui	string	Code d’application Pushwoosh
notifications*	Oui	array	Paramètres de contenu. Tableau JSON des paramètres du message. Voir les détails ci-dessous.

Paramètres de notification

Nom	Requis	Type	Description
send_date*	Oui	string	Date et heure d’envoi de la notification. Utilisez le format `AAAA-MM-JJ HH:mm` ou `'now'` pour un envoi immédiat.
content	Requis si `content_id` n’est pas fourni.	string	Contenu textuel du message WhatsApp.
content_id	Requis si `content` n’est pas fourni.	string	Identifiant d’un modèle WhatsApp pré-approuvé depuis votre compte Meta.
devices*	Oui	array	Numéro de téléphone du client (doit être associé à un ID utilisateur via `/registerDevice` et spécifié dans le paramètre `hwid`, ou utilisez `use_auto_registration`). Un seul numéro peut être spécifié ici.
use_auto_registration	Non	boolean	Si défini sur `true`, le numéro de téléphone spécifié dans le paramètre `devices` sera automatiquement enregistré.
content_variables	Non	object	Variables de contenu pour personnaliser le contenu du message. Chaque espace réservé sera remplacé par les valeurs dynamiques correspondantes.
button_url_variables	Non	object	Variables d’URL dynamiques pour les boutons. Chaque clé représente un index de bouton, et sa valeur est la variable dynamique à remplacer dans l’URL du bouton. Note : L’indexation des boutons commence à 0, le premier bouton étant 0, le deuxième 1, et ainsi de suite.
header_variables	Non	object	Variables pour l’en-tête d’un message modèle WhatsApp. Spécifiez le `type` (par ex., `text`, `image`, `video`, `document`) et la valeur correspondante. Exemple : `"header_variables": {"image": "https://image-url.png"}`
preset	Non	string	Code de préréglage WhatsApp depuis votre Panneau de configuration.
language	Non	string	Locale de langue du modèle WhatsApp (doit correspondre à la locale dans l’éditeur de modèles WhatsApp de Meta). Défaut : `"en_US"`. Exemple : `"en_GB"`.

Exemple de requête

{
  "request": {
    "application": "12XXX-67XXX",           // requis. Code d'application Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",         // requis. Jeton d'accès API depuis le Panneau de configuration de Pushwoosh.
    "notifications": [{
      "send_date": "now",                   // requis. AAAA-MM-JJ HH:mm OU "now".
      "content": "Bonjour ! {{1}}",            // requis si content_id n'est pas fourni. Texte du message.
      "content_id": "hello_world",          // requis si content n'est pas fourni. Identifiant du modèle WhatsApp.
      "devices": ["whatsapp:+1234567890"],  // requis. Numéro de téléphone WhatsApp du client (doit être associé
                                            //           à un ID utilisateur via /registerDevice et spécifié dans
                                            //           le paramètre "hwid" ou utilisez "use_auto_registration").
                                            //           Un seul numéro WhatsApp peut être spécifié ici.
      "preset": "XXXXX-XXXXX",              // optionnel. Code de préréglage WhatsApp depuis votre Panneau de configuration.
      "content_variables": {                // optionnel. Variables de contenu pour personnaliser le contenu du message.
        "1": "John"
      },
      "header_variables": {                 // optionnel. Variables pour l'en-tête du message WhatsApp.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // optionnel. Locale de langue pour le modèle WhatsApp (doit correspondre à la locale dans l'éditeur de modèles WhatsApp de Meta). Défaut : "en_US".
      "use_auto_registration": true         // optionnel. Enregistrer automatiquement le numéro WhatsApp spécifié
                                            //           dans le paramètre "devices".
    }]
  }
}

Exemple : Envoi d’un code d’authentification à deux facteurs via WhatsApp

{
    "request": {
        "application":"APP_CODE", "auth":"AUTH_TOKEN",
        "notifications":[{
            "send_date":"now",
            "content_id":"replace_with_your_meta_two_factor_template_name",
            "content_variables":{"1":"AUTH_CODE"},
            "button_url_variables":{"0":"AUTH_CODE"},
            "devices":["whatsapp:REPLACE_WITH_YOUR_PHONE_NO"]
        }]
    }
}

Exemple de réponse

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10EXXX-0D9F2XXX"
    ]
  }
}

Réponse d’erreur

{
  "status_code": 210,
  "status_message": "Liste d'appareils invalide. \"devices\" doit être un tableau.",
  "response": {
    "Messages": []
  }
}