Audience API

bulkSetTags

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

Setzt Tag-Werte für eine Liste von Geräten.

Request-Body

Name	Typ	Beschreibung
application*	String	Pushwoosh Application Code
auth*	String	API Access Token aus dem Pushwoosh Control Panel.
create_missing_tags	Boolean	Wenn true, werden fehlende Tags automatisch erstellt.
devices*	Object	Array von Geräten.
devices.hwid	String	Kann verwendet werden, um ein Gerät anstelle von user_id oder push_token zu identifizieren. Mehr erfahren
devices.user_id	String	Kann verwendet werden, um einen Benutzer anstelle von hwid oder push_token zu identifizieren. Mehr erfahren
devices.push_token	String	Kann verwendet werden, um ein Gerät anstelle von hwid oder user_id zu identifizieren. Mehr erfahren
devices.list_operator	String	Definiert, wie Werte für Tags des Listentyps gesetzt werden: set, append oder remove
devices.tags*	Object	Werte, die für die angegebenen Tags gesetzt werden sollen.

OK
Fehler

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

{
  "message": "invalid request"
}

{
  "application": "application code",   // erforderlich. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // erforderlich. API Access Token aus dem Pushwoosh Control Panel
  "create_missing_tags": false,        // optional. Sollte fehlende Tags automatisch erstellen
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // optional. Kann verwendet werden, um ein Gerät anstelle von
                                       //           "user_id" oder "push_token" zu identifizieren.
    "user_id": "user ID",              // optional. Kann verwendet werden, um einen Benutzer anstelle von "hwid" oder "push_token" zu identifizieren.
    "push_token": "device push token", // optional. Kann verwendet werden, um ein Gerät anstelle von "hwid" oder "user_id" zu identifizieren.
    "list_operator": "set",            // erforderlich. Für Listen-Tags. Definiert, wie Werte für
                                       //           Tags des Listentyps gesetzt werden: set, append oder remove
    "tags": {                          // erforderlich. Werte, die für die angegebenen Tags gesetzt werden sollen.
      "tag_name": "tagvalue",          //           korrekten Werttyp verwenden
      "tag_name2": "tagvalue2"
    }
  }]
}

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkSetTags Status

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

Gibt den Status der /bulkSetTags-Operation zurück.

Pfad-Parameter

Name	Typ	Beschreibung
request_id	String	Request-ID aus dem vorherigen `/bulkSetTags`-Aufruf

Query-Parameter

Name	Typ	Beschreibung
detailed	Boolean	(true/false) ob detaillierte Informationen pro Gerät zurückgegeben werden sollen

{
  "request_id": "id of the request",
  "status": "Completed",          // auch "Pending", "Failed"
  "progress": 100,                // Job-Fortschritt 0-100
  "devices_success": 100,         // erfolgreiche Geräte
  "devices_not_found": 0,         // Geräte in Pushwoosh nicht gefunden
  "devices_failed": 0,            // fehlerhaft
  "devices": [{                   // Gerätebericht (nur bei detailed = true)
    "hwid": "device hwid",
    "status": "done",             // auch "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

Registriert mehrere Geräte in Pushwoosh in einer einzigen Anfrage. Es ermöglicht auch die Angabe verschiedener Tags für jedes Gerät.

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

Request-Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
application	string	Ja	Pushwoosh Application Code
auth	string	Ja	API Access Token.
devices	array	Ja	Ein Array von Geräte-Objekten. Jedes Objekt repräsentiert ein Gerät und dessen zugehörige Daten. Siehe Details in der Tabelle Geräte-Objektparameter unten.

Geräte-Objektparameter

Parameter	Typ	Erforderlich	Beschreibung
hwid	string	Ja	Die Hardware-ID oder eindeutige Kennung für das Gerät.
push_token	string	Ja	Push-Token für das Gerät.
platform	integer	Ja	Der Plattform-Identifikator. Mehr erfahren
list_operator	string	Nein	Bestimmt die Aktion für Tags vom Listentyp: - “append”: Fügt den angegebenen Wert zur Tag-Liste hinzu. - “remove”: Entfernt den angegebenen Wert aus der Tag-Liste. Hinweis: Wenn der Parameter `list_operator` nicht angegeben ist, werden alle vorhandenen Werte in der Tag-Liste durch die bereitgestellten Werte ersetzt.
tags	object	Nein	Benutzerdefinierte Tags, die dem Gerät zugewiesen sind. Tags sind Schlüssel-Wert-Paare, die für die Segmentierung verwendet werden.

Anfrage-Beispiel

{
  "application": "application code",   // erforderlich. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // erforderlich. API Access Token aus dem Pushwoosh Control Panel
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // erforderlich. Eindeutige Kennung für das Gerät (kann eine E-Mail sein).
    "push_token": "device push token", // erforderlich. Push-Benachrichtigungs-Token für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform (z. B. 14 für E-Mail).
    "list_operator": "append",         // optional. Für Listen-Tags. Fügt den/die angegebenen Wert(e) zum Tag des Listentyps hinzu oder entfernt sie.
    "tags": {                          // optional. Werte, die für die angegebenen Tags gesetzt werden sollen.
      "language": "en",                //           korrekten Werttyp verwenden.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // erforderlich. Eindeutige Kennung für das zweite Gerät.
    "push_token": "device push token 2", // erforderlich. Push-Benachrichtigungs-Token für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform.
    "list_operator": "remove",         // optional. Fügt Werte zu Tags des Listentyps hinzu oder entfernt sie.
    "tags": {                          // optional. Werte, die aus den angegebenen Tags entfernt werden sollen.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // erforderlich. Eindeutige Kennung für das dritte Gerät.
    "push_token": "device push token 3", // erforderlich. Push-Benachrichtigungs-Token für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform.
    "tags": {                          // optional. Werte, die für die angegebenen Tags gesetzt werden sollen.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Antwort

Die Methode antwortet mit einer Operations-ID, die verwendet werden kann, um den Status und die Ergebnisse des Massen-Registrierungsprozesses zu verfolgen.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkRegisterDevice Status

Sie können den Status eines Massen-Registrierungsprozesses überprüfen, indem Sie die folgende GET-Anfrage stellen:

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

Parameter	Typ	Erforderlich	Beschreibung
request_id	string	Ja	Die Request-ID, die von der POST-Anfrage zurückgegeben wurde.
detailed	boolean	Nein	Wenn auf `true` gesetzt, enthält die Antwort detaillierte Ergebnisse für jedes registrierte Gerät.

Beispielantwort

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

Meldet mehrere Geräte in einer einzigen Anfrage von Pushwoosh ab.

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

Request-Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
application	string	Ja	Pushwoosh Application Code
auth	string	Ja	API Access Token
devices	array	Ja	Ein Array von Geräte-Objekten. Jedes Objekt repräsentiert ein Gerät und dessen zugehörige Daten. Siehe Details in der Tabelle Geräte-Objektparameter unten.

Geräte-Objektparameter

Parameter	Typ	Erforderlich	Beschreibung
hwid	string	Ja	Die Hardware-ID oder eindeutige Kennung für das Gerät. Mehr erfahren

Anfrage-Beispiel

{
  "application": "application code",   // erforderlich. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // erforderlich. API Access Token aus dem Pushwoosh Control Panel
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // erforderlich. Eindeutige Kennung für das Gerät (kann eine E-Mail sein).
  },
  {
    "hwid": "device hwid 2",           // erforderlich. Eindeutige Kennung für das zweite Gerät.
  },
  {
    "hwid": "device hwid 3",           // erforderlich. Eindeutige Kennung für das dritte Gerät.
  }]
}

Antwort

Die Methode antwortet mit einer Operations-ID, die verwendet werden kann, um den Status und die Ergebnisse des Massen-Prozesses zu verfolgen.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkUnregisterDevice Status

Sie können den Status eines Massen-Abmeldeprozesses überprüfen, indem Sie die folgende GET-Anfrage stellen:

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

Parameter	Typ	Erforderlich	Beschreibung
request_id	string	Ja	Die Request-ID, die von der POST-Anfrage zurückgegeben wurde.
detailed	boolean	Nein	Wenn auf `true` gesetzt, enthält die Antwort detaillierte Ergebnisse für jedes abgemeldete Gerät.

Beispielantwort

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}