Presets-API

Ein Push-Preset ist eine wiederverwendbare Vorlage für Push-Benachrichtigungen – dasselbe Objekt, das Sie im Push-Editor des Control Panels erstellen. Diese API verwaltet nur Push-Presets; SMS-, WhatsApp-, Kakao-, LINE- und Viber-Presets haben jeweils ihren eigenen dedizierten Preset-Dienst, der hier nicht behandelt wird.

Verwenden Sie den code eines Presets, um es über Notify (Payload preset) oder einen Customer Journey Send-Push-Point zu senden.

https://rpc-api.svc-nue.pushwoosh.com

Alle Endpunkte werden über HTTPS bereitgestellt. Anfragen und Antworten verwenden application/json, sofern nicht anders angegeben.

Jede Anfrage muss einen Authorization-Header mit Ihrem Server-API-Token enthalten:

Authorization: Api IHR_API_TOKEN

• Feldnamen: Anfrage-Bodys und Query-/Pfadparameter akzeptieren lowerCamelCase (zum Beispiel sendType, localizedProperties, searchByName) – der Server verarbeitet beide Schreibweisen. Antworten werden immer mit den Proto-Feldnamen in snake_case formatiert (localized_properties, platform_properties, per_page usw.). Die Antwortbeispiele und die Referenz zum Preset-Objekt unten verwenden diese Schreibweise.
• code: Jede Preset-Antwort enthält ihren eigenen Code, der bei Create generiert wird. Übergeben Sie diesen Code an Get, Update, UpdatePartial, Delete, Clone und an die oben genannten Messaging-/Journey-APIs.
• Plattformschlüssel: Die Maps platforms und open_actions sind nach dem numerischen Gerätetyp-Code (1 für iOS, 3 für Android usw.) geschlüsselt. platform_properties ist stattdessen nach dem Enum-Namen der Plattform geschlüsselt (IOS, ANDROID, BAIDU_ANDROID, HUAWEI_ANDROID, OSX – die einzigen fünf Plattformen, die es abdeckt).
• Nicht ausgefüllte Felder: Get-, Create- und Clone-Antworten enthalten jedes Feld des Preset-Objekts, auch wenn es leer ist oder den Wert Null hat. List gibt einen reduzierten Feldsatz zurück – siehe List unten. Update und UpdatePartial geben überhaupt keine Preset-Felder zurück – siehe die Warnung in ihren Abschnitten.

Delete für ein Preset, das noch von einem Send-Push-Point einer laufenden oder pausierten Journey verwendet wird, gibt ebenfalls 400 Bad Request zurück (ein FailedPrecondition auf der Leitung) – nicht 409. Entfernen Sie das Preset zuerst aus der Journey.

Erstellt ein neues Push-Preset in einer Anwendung und gibt es mit seinem generierten Code zurück.

POST /api/presets

Alle anderen Felder – lokalisierter Inhalt, Plattformen, Deep Link, Inbox, Kategorien usw. – werden mit Update geteilt und sind unten in der Referenz zum Preset-Objekt einmal dokumentiert.

{
  "application": "XXXXX-XXXXX",
  "name": "20% Rabatt",
  "platforms": { "1": true, "3": true },
  "localizedContent": {
    "default": "Holen Sie sich jetzt Ihren 20% Rabatt",
    "es": "Consigue tu 20% de descuento ahora mismo"
  },
  "localizedTitle": { "default": "Hallo" },
  "openAction": { "link": { "url": "https://example.com" } },
  "categories": ["promo"]
}

Gibt { "preset": { ... } } zurück, das erstellte Preset-Objekt.

Listet die Push-Presets einer Anwendung auf – ein reduzierter Feldsatz, nicht das vollständige Objekt – mit Paginierung, Sortierung und Filterung nach Name oder Kategorie.

GET /api/presets

Jeder Eintrag enthält nur: name, code, platforms, localized_content (einfacher Text pro Locale – nicht localized_properties), localized_title, localized_subtitle, banner, icon, categories, journey_uuid, custom_data, is_v2, created, updated. Jedes andere Feld des Preset-Objekts – localized_properties, platform_properties, deeplink, richmedia, url usw. – wird weggelassen, auch wenn es im Preset gesetzt ist.

{
  "presets": [
    { "name": "20% Rabatt", "code": "AAAAA-BBBBB", "platforms": { "1": true, "3": true }, "categories": ["promo"] }
  ],
  "page": 0,
  "per_page": 100,
  "total": 1
}

Gibt ein einzelnes Push-Preset anhand seines Codes zurück, wobei jedes Feld des Preset-Objekts ausgefüllt ist.

GET /api/presets/{code}

Gibt { "preset": { ... } } zurück, das vollständige Preset-Objekt.

Überschreibt ein bestehendes Push-Preset anhand des Codes mit den angegebenen Feldern.

PUT /api/presets/{code}

Dieselben Felder wie bei Erstellen (ohne application), plus die restlichen Felder des Preset-Objekts. sendType wird akzeptiert, aber ignoriert – der Kanal eines Presets kann nach der Erstellung nicht geändert werden.

Ein leeres Objekt bei Erfolg: {}.

Aktualisiert nur die angegebenen Felder eines bestehenden Push-Presets anhand des Codes und lässt nicht gesetzte Felder unverändert.

PUT /api/presets/{code}:partial

Dieselben Felder wie bei Update, ohne application. Im Gegensatz zu Update bleibt hier jedes Feld – einschließlich localizedProperties, platformProperties, categories und der restlichen Gruppe von Inhaltseigenschaften, die in der Warnung von Update aufgeführt sind – unverändert, wenn es weggelassen wird, und wird nur berührt, wenn Sie es senden (ein Map-/Array-Feld, das Sie senden, ersetzt immer noch den bestehenden Wert für dieses Feld vollständig, es beeinflusst nur nichts, was Sie nicht eingeschlossen haben). sendType wird ebenfalls akzeptiert, aber ignoriert.

{
  "sendRate": 500,
  "cappingCount": 3,
  "cappingDays": 7
}

Ebenfalls ein leeres Objekt – siehe die Warnung oben.

Dupliziert ein bestehendes Push-Preset unter einem neuen Namen in derselben Anwendung.

POST /api/presets/{code}:clone

{ "code": "AAAAA-BBBBB", "name": "20% Rabatt (Kopie)" }

Gibt { "preset": { ... } } zurück, das neue Preset-Objekt.

Löscht ein Push-Preset anhand seines Codes dauerhaft.

DELETE /api/presets/{code}

Ein leeres Objekt bei Erfolg: {}.

Die folgenden Feldnamen entsprechen dem, was Get, Create, Update und Clone tatsächlich zurückgeben – snake_case-Proto-Feldnamen (siehe Konventionen). Die in den obigen Anfragebeispielen verwendete lowerCamelCase-Form funktioniert bei der Eingabe auf die gleiche Weise.

Diese stammen aus dem v1-Preset-Modell. Sie werden eher aus Kompatibilitätsgründen mit dem Control Panel ausgefüllt als für neue Integrationen.

Felder, die in jedem platform_properties-Eintrag verfügbar sind (IOS, ANDROID, BAIDU_ANDROID, HUAWEI_ANDROID, OSX):