/createMessage-Parameter

Veraltet

/createMessage ist veraltet. Neue Integrationen sollten die Messaging API v2 verwenden – siehe den Migrationsleitfaden für eine feldweise Zuordnung der unten aufgeführten Parameter.

Hier finden Sie die Beschreibungen der API-Parameter von /createMessage.

• Erforderliche Parameter müssen angegeben werden, um eine /createMessage API-Anfrage erfolgreich zu senden und eine Push-Benachrichtigung zur angegebenen Zeit zu versenden.

• Optionale Parameter ermöglichen es Ihnen, die Eigenschaften von Push-Benachrichtigungen anzupassen.

Hinweis

Wenn Sie /createMessage zum Senden von SMS verwenden, beziehen Sie sich bitte auf Parameter zum Senden von SMS. Andere Parameter werden nicht übergeben.

Erforderliche Parameter

Erforderliche Parameter müssen in /createMessage-Anfragen zwingend verwendet werden. Andernfalls wird die Anfrage nicht übermittelt.

application

Eindeutiger Code einer App, die in Ihrem Pushwoosh-Konto erstellt wurde. Der App-Code befindet sich in der oberen linken Ecke des Control Panels oder in der Antwort auf eine /createApplication-Anfrage. Der App-Code ist ein durch Bindestriche getrennter Satz von 10 Zeichen (sowohl Buchstaben als auch Ziffern).

Wenn Sie eine App über die API erstellen, erhalten Sie einen App-Code in der Antwort auf Ihre /createApplication-Anfrage.

Um einen Code einer zuvor erstellten App über die API zu erhalten, rufen Sie /getApplications auf. In der Antwort auf die /getApplications-Anfrage erhalten Sie die Liste aller in Ihrem Pushwoosh-Konto erstellten Apps mit ihren Namen und Codes.

auth

API-Zugriffstoken aus dem Pushwoosh Control Panel. Gehen Sie zu Einstellungen → API-Zugriff und kopieren Sie ein Token, das Sie verwenden möchten, oder generieren Sie ein neues.

Bei der Generierung eines Zugriffstokens geben Sie dessen Berechtigungen an. Aktivieren Sie die Kontrollkästchen für die Arten von Aktivitäten, für die Sie das API-Token verwenden möchten. Sie können app-spezifische API-Token erstellen, indem Sie die Kontrollkästchen für Anwendungen aktivieren.

content

Der String oder das Objekt, das den Nachrichteninhalt definiert. Der Parameter “content”, der mit einem String-Wert übermittelt wird, sendet dieselbe Nachricht an alle Empfänger.

String

"content": "Hello world!",

JSON-Objekte werden zur Angabe von Inhalten mit Dynamic Content verwendet, zum Beispiel für mehrsprachige Nachrichten.

Object

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

Das JSON-Array der Push-Eigenschaften. Muss mindestens die erforderlichen Parameter content und send_date enthalten.

Optionale Parameter zur Verwendung innerhalb des “notifications”-Arrays:

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• message_type
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

Datum und Uhrzeit, zu der die Nachricht gesendet wird. Kann ein beliebiges Datum und eine beliebige Uhrzeit im Format YYYY-MM-DD HH:mm oder ‘now’ sein. Wenn auf ‘now’ gesetzt, wird die Nachricht sofort nach dem Absenden der Anfrage gesendet.

Optionale Parameter

campaign

Der Code einer Kampagne. Um einen Kampagnencode zu erhalten, gehen Sie zu Statistiken → Aggregierte Statistiken und wählen Sie die Kampagne aus, die Sie verwenden möchten. Der Kampagnencode wird am Ende der Seiten-URL im Format XXXXX-XXXXX sichtbar sein.

Beispiel:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

Kampagnencode: XXXXX-XXXXX

Um eine Liste von Kampagnen mit ihren Codes zu erhalten, rufen Sie /getCampaigns auf. In der Antwort auf die /getCampaigns-Anfrage erhalten Sie die Liste aller für eine bestimmte App in Ihrem Pushwoosh-Konto erstellten Kampagnen mit ihren Codes, Namen und Beschreibungen.

capping_days

Zeitraum, der für das Frequency Capping angewendet wird, in Tagen (max. 30 Tage). Siehe Frequency Capping für Details.

Frequency Capping wird nicht auf Nachrichten mit message_type: transactional angewendet. In allen anderen Fällen wird Frequency Capping angewendet, einschließlich Anfragen, bei denen message_type weggelassen wird.

capping_count

Die maximale Anzahl von Pushes, die von einer bestimmten App an ein bestimmtes Gerät innerhalb eines “capping_days”-Zeitraums gesendet werden können. Falls die erstellte Nachricht das “capping_count”-Limit für ein Gerät überschreitet, wird sie nicht an dieses Gerät gesendet. Siehe Frequency Capping für Details.

conditions

Bedingungen sind Arrays wie [tagName, operator, operand], die zum Senden gezielter Nachrichten basierend auf Tags und deren Werten verwendet werden, wobei:

• tagName — der Name eines anzuwendenden Tags,
• operator — ein Wertevergleichsoperator (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — Tag-Werte eines der folgenden Typen: string | integer | array | date | boolean | list

Operator-Beschreibung

EQ	Tag-Wert ist gleich dem Operanden.
IN	Tag-Wert überschneidet sich mit dem Operanden (Operand muss immer ein Array sein).
NOTEQ	Tag-Wert ist nicht gleich einem Operanden.
NOTIN	Tag-Wert überschneidet sich nicht mit dem Operanden (Operand muss immer ein Array sein).
GTE	Tag-Wert ist größer oder gleich dem Operanden.
LTE	Tag-Wert ist kleiner oder gleich dem Operanden.
BETWEEN	Tag-Wert ist größer oder gleich dem min-Operandenwert, aber kleiner oder gleich dem max-Operandenwert (Operand muss immer ein Array sein).
NOTSET	Tag ist nicht gesetzt. Operand wird nicht berücksichtigt.
ANY	Tag hat einen beliebigen Wert. Operand wird nicht berücksichtigt.

String-Tags

Gültige Operatoren: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY

Gültige Operanden:

EQ, NOTEQ	Operand muss ein String sein
IN, NOTIN	Operand muss ein Array von Strings sein, wie ["Wert 1", "Wert 2", "Wert N"]
NOTSET	Tag ist nicht gesetzt. Operand wird nicht berücksichtigt
ANY	Tag hat einen beliebigen Wert. Operand wird nicht berücksichtigt

Integer-Tags

Gültige Operatoren: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Gültige Operanden:

EQ, NOTEQ, GTE, LTE	Operand muss eine ganze Zahl sein
IN, NOTIN	Operand muss ein Array von ganzen Zahlen sein, wie [Wert 1, Wert 2, Wert N]
BETWEEN	Operand muss ein Array von ganzen Zahlen sein, wie [min_Wert, max_Wert]
NOTSET	Tag ist nicht gesetzt. Operand wird nicht berücksichtigt
ANY	Tag hat einen beliebigen Wert. Operand wird nicht berücksichtigt

Datums-Tags

Gültige Operatoren: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Gültige Operanden:

• "YYYY-MM-DD 00:00" (String)
• Unix-Zeitstempel 1234567890 (Integer)
• "N days ago" (String) für die Operatoren EQ, BETWEEN, GTE, LTE

Boolesche Tags

Gültige Operatoren: EQ, NOTSET, ANY

Gültige Operanden: 0, 1, true, false

Listen-Tags

Gültige Operatoren: IN, NOTIN, NOTSET, ANY

Gültige Operanden: Operand muss ein Array von Strings sein, wie ["Wert 1", "Wert 2", "Wert N"].

Wichtig

Denken Sie daran, dass die Parameter „filter“ und „conditions“ nicht zusammen verwendet werden sollten.
Außerdem werden beide ignoriert, wenn der Parameter „devices“ in derselben Anfrage verwendet wird.

Länder- und Sprach-Tags

Der Wert des Sprach-Tags ist ein zweibuchstabiger Kleinbuchstabencode gemäß ISO-639-1. Der Wert des Länder-Tags ist ein zweibuchstabiger GROSSBUCHSTABEN-Code gemäß ISO_3166-2.

Um beispielsweise eine Push-Benachrichtigung an portugiesischsprachige Abonnenten in Brasilien zu senden, müssen Sie die folgende Bedingung angeben: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

Logischer Operator für conditions-Arrays. Mögliche Werte: AND | OR. AND ist der Standardwert.

Wenn der angewendete Operator AND ist (wenn kein Operator angegeben ist oder der Parameter ‘conditions_operator’ den Wert ‘AND’ hat), erhalten Geräte, die gleichzeitig alle Bedingungen erfüllen, die Push-Benachrichtigung.

Wenn der Operator OR ist, erhalten Geräte, die eine der angegebenen Bedingungen erfüllen, die Nachricht.

data

JSON-String oder JSON-Objekt, das verwendet wird, um beliebige benutzerdefinierte Daten in der Push-Payload zu übergeben; wird als “u”-Parameter in der Payload übergeben (in einen JSON-String konvertiert).

devices

Das Array von Push-Token oder HWIDs zum Senden gezielter Push-Benachrichtigungen. Wenn gesetzt, wird die Nachricht nur an die Geräte auf der Liste gesendet.

dynamic_content

Platzhalter für Dynamic Content, die anstelle von Geräte-Tag-Werten verwendet werden sollen. Das folgende Beispiel sendet die Nachricht “Hallo, John!” an jeden Benutzer, den Sie ansprechen. Wenn nicht gesetzt, werden die Dynamic Content-Werte aus den Geräte-Tags übernommen.

"content": "Hallo, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

Der Name eines Segments, genau wie es im Pushwoosh Control Panel oder über eine /createFilter API-Anfrage erstellt wurde. Gehen Sie zum Abschnitt Audience → Segmente und überprüfen Sie die Liste der erstellten Segmente.

Um die Segmentliste über die API zu erhalten, rufen Sie die API-Methode /listFilters auf. In der Antwort auf die /listFilters-Anfrage erhalten Sie die Liste aller in Ihrem Pushwoosh-Konto erstellten Segmente mit den Namen, Bedingungen und Ablaufdaten der Segmente.

ignore_user_timezone

Wenn auf ‘true’ gesetzt, wird die Nachricht zu der im Parameter “send_date” angegebenen Zeit und Datum gemäß UTC-0 gesendet.

Wenn auf ‘false’ gesetzt, erhalten die Benutzer die Nachricht zur angegebenen lokalen Zeit gemäß den Einstellungen ihres Geräts.

inbox_date

Das Datum, bis zu dem die Nachricht im Posteingang der Benutzer aufbewahrt werden soll. Wenn nicht angegeben, wird die Nachricht am nächsten Tag nach dem Sendedatum aus dem Posteingang entfernt.

Hinweis

Um die Nachricht im Posteingang zu speichern, verwenden Sie mindestens einen der ‘inbox’-Parameter: “inbox_date” oder “inbox_image”.

Vorsicht

Die Nachricht wird am angegebenen Datum um 00:00:01 Uhr aus dem Posteingang entfernt, sodass der vorherige Tag der letzte Tag ist, an dem ein Benutzer die Nachricht in seinem Posteingang sehen kann.

inbox_image

Die URL des benutzerdefinierten Bildes, das neben der Nachricht im Posteingang angezeigt werden soll.

Hinweis

Um die Nachricht im Posteingang zu speichern, verwenden Sie mindestens einen der ‘inbox’-Parameter: “inbox_date” oder “inbox_image”.

inbox_days

Die Lebensdauer einer Posteingangsnachricht in Tagen, bis zu 30 Tage. Nach diesem Zeitraum wird die Nachricht aus dem Posteingang entfernt. Kann anstelle des Parameters inbox_date verwendet werden.

link

Die URL, die geöffnet wird, sobald ein Benutzer eine Push-Benachrichtigung öffnet.

message_type

Gibt den Typ der Push-Nachricht an. Verfügbare Werte sind marketing und transactional. Siehe Marketing- vs. Transaktionsnachrichten für Details.

Dieser Parameter ist optional. Wenn er weggelassen wird, wird die Nachricht als transaktional behandelt und an alle zugestellt, einschließlich der Kontrollgruppe. Marketingnachrichten werden nicht an Mitglieder der Kontrollgruppe zugestellt.

minimize_link

Kürzungsdienst, um die im Parameter “link” übermittelte URL zu minimieren. Bitte beachten Sie, dass die Größe der Push-Benachrichtigungs-Payload begrenzt ist. Erwägen Sie daher, kurze URLs zu erstellen, um das Limit nicht zu überschreiten. Verfügbare Werte: 0 — nicht minimieren, 2 — bitly. Standard = 2. Der Google URL-Kürzungsdienst ist seit dem 30. März 2019 deaktiviert.

platforms

Das Array von Plattform-Codes, um die Nachricht nur an bestimmte Plattformen zu senden.

Verfügbare Plattform-Codes sind: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — E-Mail, 17 — Huawei, 18 — SMS und 21 — WhatsApp.

preset

Der Code eines Presets, das im Pushwoosh Control Panel oder über die API erstellt wurde. Um einen Preset-Code zu erhalten, gehen Sie zu Inhalt → Presets, erweitern Sie das Preset, das Sie verwenden möchten, und kopieren Sie den Preset-Code aus den Details des Presets.

rich_media

Der Code einer Rich Media-Seite, die Sie an Ihre Nachricht anhängen möchten. Um einen Code zu erhalten, gehen Sie zu Inhalt → Rich Media, öffnen Sie eine Rich Media-Seite, die Sie verwenden möchten, und kopieren Sie den Code aus der URL-Leiste Ihres Browsers. Der Code ist ein durch Bindestriche getrennter Satz von 10 Zeichen (sowohl Buchstaben als auch Ziffern).

send_rate

Drosselung zur Begrenzung der Push-Sendegeschwindigkeit. Gültige Werte liegen zwischen 100 und 1000 Pushes/Sekunde.

timezone

Zeitzone, die berücksichtigt werden soll, wenn die Nachricht an einem bestimmten Datum und zu einer bestimmten Uhrzeit gesendet wird. Wenn gesetzt, wird die Zeitzone des Geräts ignoriert. Wenn ignoriert, wird die Nachricht in UTC gesendet. Siehe https://php.net/manual/timezones.php für unterstützte Zeitzonen.

template_bindings

Vorlagenplatzhalter zur Verwendung in Ihrer Inhaltsvorlage. Siehe den Liquid Templates-Leitfaden für Details.

transactionId

Eindeutiger Nachrichtenidentifikator, um das Duplizieren von Nachrichten bei Netzwerkproblemen zu verhindern. Sie können jeder Nachricht, die über die Anfrage /createMessage oder /createTargetedMessage erstellt wird, eine beliebige ID zuweisen. Wird auf der Seite von Pushwoosh für 5 Minuten gespeichert.

use_latest_user_device

Wenn auf true gesetzt, wird ein Push pro Benutzer anstelle von einem pro Gerät zugestellt: Nur das Gerät mit dem letzten „Last Application Open“ unter den Plattformen in platforms erhält es. Wenn keines der Geräte eines Benutzers auf diesen Plattformen diese Daten hat, erhält stattdessen das erste passende Gerät die Nachricht, sodass der Versand nie verworfen wird. Geräte ohne Benutzer-ID sind nicht betroffen. Gilt unabhängig davon, wie die Zielgruppe angesprochen wurde – durch users, filter oder conditions. Funktioniert genauso wie use_latest_user_device in der Messaging API v2. Standard ist false (an jedes Gerät senden).

users

Das Array von userIds. Die User ID ist ein eindeutiger Benutzeridentifikator, der durch eine API-Anfrage /registerUser, /registerDevice oder /registerEmail gesetzt wird.