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.

Anfragekörper

Parameter	Typ	Erforderlich/Optional	Beschreibung
application	String	Erforderlich	Pushwoosh-Anwendungscode
auth	String	Erforderlich	API-Zugriffstoken aus dem Pushwoosh Control Panel.
notifications	Array	Erforderlich	JSON-Array mit Nachrichtenparametern. Details finden Sie in der nachstehenden Tabelle „Benachrichtigungen“.

Benachrichtigungen

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. Auf iOS 16.1+ (mit Live Activity-Unterstützung) stammt der Inhalt aus dem Feld `live_activity`.
title	String	Optional	Der Titel der Benachrichtigungsnachricht.
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 in der Live Activity verwendeten Attribute.
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 zum Ansprechen bestimmter Zielgruppensegmente.
devices	Array of strings	Optional	Tokens oder HWIDs, um gezielte Push-Benachrichtigungen zu senden, mit einem Maximum von 1000. Wenn festgelegt, wird die Nachricht nur an die Geräte in der Liste gesendet. Hinweis: Die Anwendungsgruppe für die Geräteliste ist nicht zulässig, und iOS-Push-Token müssen in Kleinbuchstaben angegeben werden.
users	Array of strings	Optional	Wenn festgelegt, wird die Nachricht nur an die angegebenen Benutzer-IDs (zugewiesen über den Aufruf `/registerUser`) zugestellt. Sie können bis zu 1000 Benutzer-IDs in das Array aufnehmen. Hinweis: Bei gemeinsamer Verwendung mit dem `devices`-Parameter hat der `users`-Parameter Vorrang. Die Anwendungsgruppe für die Benutzerliste ist nicht zulässig.

Antwort

200

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

Anfragebeispiel

{
  "request": {
    "application": "XXXXX-XXXXX",        // erforderlich. Pushwoosh-Anwendungscode
    "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. Tokens oder HWIDs angeben, um gezielte Push-
          "hwid_XXXX"                    //           Benachrichtigungen zu senden. Nicht mehr als 1000 Tokens/HWIDs in
      ],                                 //           einem Array. Wenn festgelegt, wird die Nachricht nur an
                                         //           die Geräte in der Liste gesendet. Anwendungsgruppe für
                                         //           die Geräteliste ist nicht zulässig.
                                         //           iOS-Push-Token dürfen nur in Kleinbuchstaben sein.
      "users": [                         // optional. Wenn festgelegt, wird die Nachricht nur an die angegebenen
        "user_XXXX"                      //           Benutzer-IDs zugestellt (festgelegt über den /registerUser-Aufruf). Wenn
      ]                                  //           zusammen mit dem devices-Parameter angegeben, wird letzterer
                                         //           ignoriert. Nicht mehr als 1000 Benutzer-IDs in einem Array.
                                         //           Anwendungsgruppe für die Benutzerliste ist nicht zulässig.
    }]
  }
}

Hinweis:

Lesen Sie diesen Artikel, um mehr über die Arbeit mit Live Activities mit dem 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.

Anfragekörper

Parameter	Typ	Erforderlich/Optional	Beschreibung
auth	String	Erforderlich	API-Zugriffstoken aus dem Pushwoosh Control Panel.
application	String	Erforderlich	Pushwoosh-Anwendungscode
notifications	Array	Erforderlich	JSON-Array mit Nachrichtenparametern. Details finden Sie in der nachstehenden Tabelle „Benachrichtigungen“.

Benachrichtigungen

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, das verwendet wird, um Daten an die Live Activity zu übergeben, um deren Inhalt zu aktualisieren.
dismissal-date	Integer	Optional	Die Zeit (in Sekunden), zu der die Live Activity enden soll.
live_activity_id	String	Erforderlich	Ein eindeutiger Bezeichner für die Live Activity, die aktualisiert wird.
relevance-score	Integer	Optional	Teilt dem iOS-System mit, welche Live Activity eine höhere Priorität als andere hat. Akzeptiert Werte von 1 bis unendlich (Werte bis 100 werden empfohlen).
stale-date	Integer	Optional	Die Zeit (in Sekunden), die das Datum darstellt, an dem eine Live Activity veraltet oder nicht mehr aktuell ist.

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

Anfragebeispiel

{
  "request": {
    "application": "XXXXX-XXXXX",        // erforderlich. Pushwoosh-Anwendungscode
    "auth": "yxoPUlwqm…………pIyEX4H",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // erforderlich. Live Activity-Daten zum Aktualisieren einer Live Activity in iOS
        "event": "update",               // erforderlich. Verwenden Sie „update“, um die Live Activity zu aktualisieren, oder
                                         //           „end“, um die Live Activity zu schließen
        "content-state": {               // erforderlich. Objekt mit Schlüssel-Wert-Paaren, das verwendet wird, um Daten
          "courierName": "NUMBER: 15",   //           an die Live Activity zu übergeben, um deren Inhalt zu aktualisieren
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // optional. Zeit des Endes der Live Activity in Sekunden
        "relevance-score": 50,           // optional. Priorität für die Live Activity (1 bis 100 empfohlen)
        "stale-date": 23456789           // optional. Zeit (in Sekunden), zu der 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 mit dem Pushwoosh iOS SDK zu erfahren.