SMS API

createSMSMessage

Wird verwendet, um SMS-Benachrichtigungen an Benutzer zu senden.

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

Request Body

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*	Ja	string	Textinhalt der SMS-Nachricht.
devices*	Ja	array	Telefonnummer des Kunden (muss mit `/registerDevice` einem UserId zugeordnet und im Parameter `hwid` 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 Parameter `devices` angegebene Telefonnummer automatisch registriert.
dynamic_content_placeholders	Nein	object	Platzhalter für dynamischen Inhalt zur Anpassung des Nachrichteninhalts. Jeder Platzhalter wird durch entsprechende dynamische Werte ersetzt.
preset	Nein	string	SMS-Preset-Code aus Ihrem Control Panel.

Anfrage-Beispiel

{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",            // required. YYYY-MM-DD HH:mm OR "now".
      "content": "Hello!",           // required. SMS text (string).
      "devices": ["+1234567890"],    // required. Customer phone number (must be associated with
                                     //           a UserId using. /registerDevice and specified in
                                     //           the "hwid" parameter or use "use_auto_registration").
                                     //           Only one number can be specified here.
      "preset": "XXXXX-XXXXX",       // optional. SMS Preset Code from your Control Panel.
      "use_auto_registration": true  // optional. Automatically register phone number specified
                                     //           in "devices" parameter.
    }]
  }
}

Antwort-Beispiel

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

Fehlerantwort

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

Um SMS-Statistiken abzurufen, verwenden Sie die Methode totalsByIntervals.

Sie können Statistiken für jede Nachricht auch im Bereich Message History einsehen.