iOS Live Activities API

Apple-Dokumentation:

Über Live Activities

Aktualisieren und Beenden von Live Activities mit ActivityKit-Push-Benachrichtigungen

startLiveActivity

Verwenden Sie diese Methode, um iOS Live Activities zu erstellen.

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

Ermöglicht das Erstellen von iOS Live Activities.

Request-Body

Parameter	Typ	Erforderlich/Optional	Beschreibung
application	String	Erforderlich	Pushwoosh-Application-Code
auth	String	Erforderlich	API-Zugriffstoken aus dem Pushwoosh Control Panel.
notifications	Array	Erforderlich	JSON-Array mit Nachrichtenparametern. Siehe Details in der Tabelle “Notifications” unten.

Notifications

Parameter, die im notifications-Array verwendet werden:

Parameter	Typ	Erforderlich/Optional	Beschreibung
content	String	Erforderlich	Fallback-Inhalt für Geräte mit iOS-Versionen unter 16.1, die Live Activity nicht unterstützen. Unter iOS 16.1+ (mit Live-Activity-Unterstützung) stammt der Inhalt aus dem Feld `live_activity`.
title	String	Optional	Der Titel der Benachrichtigung.
live_activity	Object	Erforderlich	Live-Activity-Daten zum Erstellen einer Live Activity in iOS.
content-state	Object	Erforderlich	Inhalt für die Live-Activity-Benachrichtigung.
attributes-type	String	Erforderlich	Der Typ der Attribute, die in der Live Activity verwendet werden.
attributes	Object	Erforderlich	Attribute für die Live Activity.
live_activity_id	String	Erforderlich	Eine eindeutige ID für die Live Activity, die vom Benutzer erstellt wird.
filter_code	String	Optional	Filter (Segment)-Code, um bestimmte Zielgruppensegmente anzusprechen.
devices	Array of strings	Optional	Token oder HWIDs, um gezielte Push-Benachrichtigungen zu senden (maximal 1000). Wenn gesetzt, wird die Nachricht nur an die Geräte in der Liste gesendet. Hinweis: Die Application Group für die Geräteliste ist nicht zulässig, und iOS-Push-Token müssen kleingeschrieben sein.
users	Array of strings	Optional	Wenn gesetzt, wird die Nachricht nur an die angegebenen User IDs zugestellt (zugewiesen über den Aufruf `/registerUser`). Sie können bis zu 1000 User IDs in das Array aufnehmen. Hinweis: Bei gemeinsamer Verwendung mit dem Parameter `devices` hat der Parameter `users` Vorrang. Application Group für die Benutzerliste ist nicht zulässig.

Antwort

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Anfrage-Beispiel

{
  "request": {
    "application": "XXXXX-XXXXX",        // erforderlich. Pushwoosh-Application-Code
    "auth": "yxoPUlwqm…………pIyEX4H",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // erforderlich. Live-Activity-Daten zum Erstellen einer Live Activity in iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // optional. Eindeutiger Bezeichner der Live Activity.
      "filter_code": "FILTER_NAME",      // optional. Filter angeben.
      "devices": [                       // optional. Token oder HWIDs für gezielte Push-Benachrichtigungen
          "hwid_XXXX"                    //           angeben. Nicht mehr als 1000 Token/HWIDs in einem
      ],                                 //           Array. Wenn gesetzt, wird die Nachricht nur an die
                                         //           Geräte auf der Liste gesendet. Application Group für
                                         //           Geräteliste ist nicht zulässig.
                                         //           iOS-Push-Token dürfen nur Kleinbuchstaben enthalten.
      "users": [                         // optional. Wenn gesetzt, wird die Nachricht nur an die angegebenen
        "user_XXXX"                      //           User IDs zugestellt (gesetzt über /registerUser). Wenn
      ]                                  //           zusammen mit dem devices-Parameter angegeben, wird letzterer
                                         //           ignoriert. Nicht mehr als 1000 User IDs in einem Array.
                                         //           Application Group für Benutzerliste ist nicht zulässig.
    }]
  }
}

Hinweis:

Lesen Sie diesen Artikel, um mehr über die Arbeit mit Live Activities unter Verwendung des Pushwoosh iOS SDK zu erfahren.

updateLiveActivity

Verwenden Sie diese Methode, um iOS Live Activities zu verwalten.

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

Ermöglicht das Erstellen und Verwalten von iOS Live Activities.

Request-Body

Parameter	Typ	Erforderlich/Optional	Beschreibung
auth	String	Erforderlich	API-Zugriffstoken aus dem Pushwoosh Control Panel.
application	String	Erforderlich	Pushwoosh-Application-Code
notifications	Array	Erforderlich	JSON-Array mit Nachrichtenparametern. Siehe Details in der Tabelle “Notifications” unten.

Notifications

Parameter, die im notifications-Array verwendet werden:

Parameter	Typ	Erforderlich/Optional	Beschreibung
live_activity	Object	Erforderlich	Live-Activity-Daten zum Aktualisieren einer Live Activity in iOS.
event	String	Erforderlich	Gibt den Ereignistyp an. Verwenden Sie `"update"`, um die Live Activity zu aktualisieren, oder `"end"`, um sie zu schließen.
content-state	Object	Erforderlich	Objekt mit Schlüssel-Wert-Paaren, um Daten an die Live Activity zur Aktualisierung ihres Inhalts zu übergeben.
dismissal-date	Integer	Optional	Der Zeitpunkt (in Sekunden), zu dem die Live Activity enden soll.
live_activity_id	String	Erforderlich	Ein eindeutiger Bezeichner für die Live Activity, die aktualisiert wird.
stale-date	Integer	Optional	Der Zeitpunkt (in Sekunden), der das Datum darstellt, an dem eine Live Activity veraltet (stale) wird.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Anfrage-Beispiel

{
  "request": {
    "application": "XXXXX-XXXXX",        // erforderlich. Pushwoosh-Application-Code
    "auth": "yxoPUlwqm…………pIyEX4H",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // erforderlich. Live-Activity-Daten zum Aktualisieren der Live Activity in iOS
        "event": "update",               // erforderlich. Verwenden Sie "update" zum Aktualisieren der Live Activity
                                         //           oder "end" zum Schließen der Live Activity
        "content-state": {               // erforderlich. Objekt mit Schlüssel-Wert-Paaren zur Übergabe von Daten
          "courierName": "NUMBER: 15",   //           an die Live Activity zur Aktualisierung ihres Inhalts
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // optional. Endzeitpunkt der Live Activity in Sekunden
        "stale-date": 23456789           // optional. Zeitpunkt (in Sekunden), wann die Live Activity veraltet
      },
      "live_activity_id": "unique UUID"  // optional. Eindeutiger Bezeichner der Live Activity.
    }]
  }
}

Lesen Sie diesen Artikel, um mehr über die Arbeit mit Live Activities unter Verwendung des Pushwoosh iOS SDK zu erfahren.