WhatsApp API

createWhatsAppMessage

Wird verwendet, um WhatsApp-Nachrichten an Benutzer zu senden

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

Anfragekörper

Name	Erforderlich	Typ	Beschreibung
auth*	Ja	string	API-Zugriffstoken aus dem Pushwoosh Control Panel.
application*	Ja	string	Pushwoosh-Anwendungscode
notifications*	Ja	array	Inhaltseinstellungen. JSON-Array von Nachrichtenparametern. Siehe Details unten.

Benachrichtigungsparameter

Name	Erforderlich	Typ	Beschreibung
send_date*	Ja	string	Datum und Uhrzeit zum Senden der Benachrichtigung. Verwenden Sie das Format `YYYY-MM-DD HH:mm` oder `'now'`, um sofort zu senden.
content	Erforderlich, wenn `content_id` nicht angegeben ist.	string	Textinhalt der WhatsApp-Nachricht.
content_id	Erforderlich, wenn `content` nicht angegeben ist.	string	Kennung für eine vorab genehmigte WhatsApp-Vorlage aus Ihrem Meta-Konto.
devices*	Ja	array	Telefonnummer des Kunden (muss mit einer Benutzer-ID unter Verwendung von `/registerDevice` verknüpft und im `hwid`-Parameter angegeben sein, oder verwenden Sie `use_auto_registration`). Hier kann nur eine Nummer angegeben werden.
use_auto_registration	Nein	boolean	Wenn auf `true` gesetzt, wird die im `devices`-Parameter angegebene Telefonnummer automatisch registriert.
content_variables	Nein	object	Inhaltsvariablen zur Anpassung des Nachrichteninhalts. Jeder Platzhalter wird durch entsprechende dynamische Werte ersetzt.
button_url_variables	Nein	object	Dynamische URL-Variablen für Schaltflächen. Jeder Schlüssel repräsentiert einen Schaltflächenindex, und sein Wert ist die dynamische Variable, die in der URL der Schaltfläche ersetzt werden soll. Hinweis: Die Schaltflächenindizierung beginnt bei 0, wobei die erste Schaltfläche 0, die zweite 1 ist und so weiter.
header_variables	Nein	object	Variablen für den Header in einer WhatsApp-Vorlagennachricht. Geben Sie den `type` (z. B. `text`, `image`, `video`, `document`) und den entsprechenden Wert an. Beispiel: `"header_variables": {"image": "https://image-url.png"}`
preset	Nein	string	WhatsApp-Preset-Code aus Ihrem Control Panel.
language	Nein	string	Sprach-Locale der WhatsApp-Vorlage (muss mit dem Locale im Meta WhatsApp-Vorlageneditor übereinstimmen). Standard: `"en_US"`. Beispiel: `"en_GB"`.

Anfragebeispiel

{
  "request": {
    "application": "12XXX-67XXX",           // erforderlich. Pushwoosh-Anwendungscode.
    "auth": "yxoPUlwqm…………pIyEX4H",         // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",                   // erforderlich. YYYY-MM-DD HH:mm ODER "now".
      "content": "Hello! {{1}}",            // erforderlich, wenn content_id nicht angegeben ist. Nachrichtentext.
      "content_id": "hello_world",          // erforderlich, wenn content nicht angegeben ist. WhatsApp-Vorlagenkennung.
      "devices": ["whatsapp:+1234567890"],  // erforderlich. WhatsApp-Telefonnummer des Kunden (muss verknüpft sein
                                            //           mit einer UserId unter Verwendung von /registerDevice und angegeben im
                                            //           "hwid"-Parameter oder verwenden Sie "use_auto_registration").
                                            //           Hier kann nur eine WhatsApp-Nummer angegeben werden.
      "preset": "XXXXX-XXXXX",              // optional. WhatsApp-Preset-Code aus Ihrem Control Panel.
      "content_variables": {                // optional. Inhaltsvariablen zur Anpassung des Nachrichteninhalts.
        "1": "John"
      },
      "header_variables": {                 // optional. Variablen für den WhatsApp-Nachrichten-Header.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // optional. Sprach-Locale für die WhatsApp-Vorlage (muss mit dem Locale im Meta WhatsApp-Vorlageneditor übereinstimmen). Standard: "en_US".
      "use_auto_registration": true         // optional. Registriert automatisch die angegebene WhatsApp-Nummer
                                            //           im "devices"-Parameter.
    }]
  }
}

Beispiel: Senden eines Zwei-Faktor-Authentifizierungscodes über 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"]
        }]
    }
}

Antwortbeispiel

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

Fehlerantwort

{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}