Referenzindex der API-Methoden

Pushwoosh bietet eine umfangreiche Bibliothek mit über 100 API-Methoden, die für verschiedene Funktionalitäten wie das Senden von Benachrichtigungen, die Verwaltung von Benutzern und das Tracking von Analysen kategorisiert sind.

Messaging API v2

Einheitliche API, die die gesamte /create*Message-Familie (Push, E-Mail, SMS, Kakao) ersetzt. Siehe die Übersicht und den Migrationsleitfaden.

Notify	Erstellt und sendet eine einzelne Nachricht über einen beliebigen Kanal. Ersetzt /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage.

SMTP-Gateway

Senden Sie transaktionale E-Mails über Standard-SMTP, anstatt die API direkt aufzurufen. Das Gateway authentifiziert sich mit Ihrem Anwendungscode und API-Token und leitet dann jede Nachricht an Notify weiter. Siehe die SMTP-Gateway-Referenz.

Nachrichten-API

createMessage Veraltet	Erstellt eine neue Push-Benachrichtigung. Verwenden Sie stattdessen Notify.
deleteMessage	Löscht eine geplante Nachricht.
getMessageDetails	Ruft die Nachrichtendetails ab.
createTargetedMessage Veraltet	Erstellt eine neue gezielte Push-Benachrichtigung. Verwenden Sie stattdessen Notify mit der Art transactional.
getPushHistory Veraltet	Verwenden Sie /messages:list, um den Nachrichtenverlauf mit detaillierten Daten abzurufen.
cancelMessage	Storniert eine geplante Nachricht.

Presets-API

createPreset	Erstellt ein neues Preset.
getPreset	Ruft die Parameter des angegebenen Push-Presets ab.
listPresets	Ruft eine Liste der für die App erstellten Presets ab.
deletePreset	Löscht ein Preset aus Ihrem Konto.

Geräte-API

registerDevice	Registriert ein Gerät für die Anwendung.
unregisterDevice	Entfernt das Push-Token des Geräts.
deleteDevice	Löscht ein Gerät und alle zugehörigen Daten in der angegebenen Anwendung.
setTags	Legt Tag-Werte für das Gerät fest.
getTags	Ruft Tags mit ihren entsprechenden Werten für ein bestimmtes Gerät ab.
setBadge	Sendet den aktuellen Badge-Wert für ein Gerät an Pushwoosh.
applicationOpen	Registriert ein App-Öffnungs-Ereignis.
pushStat	Registriert ein Push-Öffnungs-Ereignis.
messageDeliveryEvent	Registriert ein Push-Zustellungs-Ereignis für das Gerät.

Audience-API

bulkSetTags	Legt Tag-Werte für mehrere Geräte fest.
bulkSetTags Status	Gibt den Status der bulkSetTags-Operation zurück.
bulkRegisterDevice	Registriert mehrere Geräte in einer einzigen Anfrage, einschließlich optionaler Tag-Werte für jedes Gerät.
bulkRegisterDevice Status	Ruft den Status und die Ergebnisse einer Massenregistrierungsanfrage für Geräte unter Verwendung einer Anfrage-ID ab.
bulkUnregisterDevice	Meldet mehrere Geräte in einer einzigen Anfrage ab.
bulkUnregisterDevice Status	Ruft den Status und die Ergebnisse einer Massenabmeldungsanfrage für Geräte unter Verwendung einer Anfrage-ID ab.

Tags-API

addTag	Erstellt ein Tag in Ihrem Konto.
deleteTag	Entfernt ein Tag mit allen zugehörigen Informationen.
listTags	Ruft eine Liste der Tags im Konto ab.

Segmentierungs- (Filter-) API

createFilter	Erstellt ein neues Segment.
listFilters	Gibt eine Liste der verfügbaren Segmente mit ihren Bedingungen zurück.
deleteFilter	Löscht ein vorhandenes Segment.
exportSegment	Plant eine Anfrage zum Exportieren von Abonnenten, die den Segmentbedingungen entsprechen.
exportSegment Results	Ruft den CSV-Link für die Ergebnisse von exportSegment ab.

Benutzerzentrierte API

registerUser	Verknüpft eine externe Benutzer-ID mit einem bestimmten Gerät.
deleteUser	Löscht einen Benutzer und alle Geräte, die mit der angegebenen Benutzer-ID verknüpft sind.
postEvent	Ruft das Ereignis innerhalb der App auf.

Events-API

createEvent	Erstellt ein Ereignis für die App.

Anwendungs-API

createApplication	Erstellt eine neue Anwendung im Konto.
updateApplication	Aktualisiert die Anwendungseinstellungen.
deleteApplication	Löscht die App aus dem Konto.
getApplication	Ruft Details zur App ab.
getApplications	Ruft eine Liste der Anwendungen im Konto ab.
getApplicationFile	Ruft die Konfigurationsdateien ab, die sich auf die App beziehen.
setApplicationPlatformStatus	Ändert den Plattformstatus der App.

Kampagnen-API

createCampaign	Erstellt eine neue Push-Kampagne.
deleteCampaign	Löscht eine bestimmte Kampagne.
getCampaigns	Ruft eine Liste der Kampagnen für die App ab.

App-Konfigurations-API

configureApplication for iOS	Konfiguriert die iOS-Plattform für die App.
configureApplication for Android	Konfiguriert die Android-Plattform für die App.
configureApplication for Mac OS X	Konfiguriert die macOS-Plattform für die App.
configureApplication for Windows	Konfiguriert die Windows-Plattform für die App.
configureApplication for Amazon	Konfiguriert die Amazon-Plattform für die App.
configureApplication for Chrome	Konfiguriert die Chrome-Plattform für die App.
configureApplication for Safari	Konfiguriert die Safari-Plattform für die App.
configureApplication for Firefox	Konfiguriert die Firefox-Plattform für die App.
configureApplication for Email	Konfiguriert die E-Mail-Plattform für die App.

E-Mail-API

createEmailMessage Veraltet	Erstellt eine E-Mail-Nachricht. Verwenden Sie stattdessen Notify mit platforms: ["EMAIL"] und einem email_payload.
registerEmail	Registriert eine E-Mail-Adresse für die App.
deleteEmail	Entfernt eine E-Mail-Adresse aus Ihrer Datenbank.
setEmailTags	Legt Tag-Werte für die angegebene E-Mail-Adresse fest.
registerEmailUser	Verknüpft eine externe Benutzer-ID mit einer angegebenen E-Mail-Adresse.

Testgeräte-API

createTestDevice	Registriert ein Testgerät für die Anwendung.
listTestDevices	Ruft alle für die Anwendung registrierten Testgeräte ab.

Nachrichten-Posteingangs-API

getInboxMessages	Ruft die Liste der Posteingangsnachrichten für eine bestimmte HWID ab.
inboxStatus	Aktualisiert den Status einer bestimmten Posteingangsnachricht.

Statistik-API

Nachrichtenstatistiken

messages:list	Ruft eine Liste der gesendeten Nachrichten ab.
totalsByIntervals	Liefert Metriken und Konversionsdaten, die stündlich aggregiert werden.
getMessageLog	Ruft detaillierte Informationen über gesendete Nachrichten ab.
linksInteractions	Liefert Statistiken zu Klicks auf E-Mail-Links.
linksInteractionsDevices	Listet Benutzer auf, die auf Links in E-Mails geklickt haben.
bouncedEmails	Liefert Informationen zu E-Mail-Bounces, Beschwerden und Bounce-Gründen.

Anwendungs- und Abonnentenstatistiken

getApplicationSubscribersStats	Ruft die Abonnentenstatistiken der App ab, gruppiert nach Gerätetyp.
getAppStats	Ruft App-Statistiken für einen bestimmten Zeitraum ab.
getSubscribersStatistics	Ruft Abonnentenstatistiken für einen bestimmten Zeitraum ab.

Kampagnenstatistiken

getCampaignStats	Ruft Kampagnenstatistiken für einen bestimmten Zeitraum ab.

Event- und Tag-Statistiken

getEventStatistics	Ruft die Anzahl ab, wie oft ein Ereignis während eines bestimmten Zeitraums ausgelöst wurde.
getTagStats	Ruft Statistiken für ein bestimmtes Tag ab.

iOS Live Activities API

startLiveActivity	Erstellt eine neue iOS Live Activity.
updateLiveActivity	Aktualisiert eine bestehende iOS Live Activity.

Apple Wallet PassKit API

Apple Wallet PassKit API	Referenz zur Verwaltung von Apple Wallet Pässen und der zugehörigen Konfiguration in Pushwoosh.

Customer Journey API

Get Journey stats	Ruft Statistiken für eine bestimmte Journey anhand ihrer ID ab.
Remove users from journeys	Entfernt einen oder mehrere Benutzer aus allen oder ausgewählten aktiven Journeys.

API für geplante Anfragen

getResults	Ruft das Ergebnis einer geplanten Anfrage ab.

SMS-API

createSMSMessage Veraltet	Erstellt eine neue SMS-Nachricht. Verwenden Sie stattdessen Notify mit platforms: ["SMS"].

WhatsApp-API

createWhatsAppMessage Veraltet	Erstellt eine neue WhatsApp-Nachricht. Verwenden Sie stattdessen Notify mit platforms: ["WHATS_APP"].

LINE-API

createLineMessage Veraltet	Erstellt eine neue LINE-Nachricht. Verwenden Sie stattdessen Notify mit platforms: ["LINE"].

Kakao-API

createKakaoMessage Veraltet	Sendet eine Kakao-Nachricht unter Verwendung einer genehmigten Vorlage. Verwenden Sie stattdessen Notify mit platforms: ["KAKAO"].

Geozones-API

getNearestZone	Ruft die Parameter der nächstgelegenen Geozone und die Entfernung dorthin ab. Zeichnet auch den Gerätestandort für Geo-Push-Benachrichtigungen auf.
addGeoZone	Fügt einer bestimmten App eine Geozone hinzu.
updateGeoZone	Aktualisiert Geozone-Eigenschaften wie Name, Status, Inhalt und Reichweite.
deleteGeoZone	Entfernt Geozones aus der App.
addGeoZoneCluster	Fügt der App einen Geozone-Cluster hinzu.
deleteGeoZoneCluster	Entfernt einen Geozone-Cluster aus der App.
listGeoZones	Ruft eine Liste der Geozones für die App ab.
listGeoZoneClusters	Ruft eine Liste der Geozone-Cluster für die App ab.