iOS Live Activities API

Apple-Dokumentation:

• Über Live Activities
• Aktualisieren und Beenden von Live Activities mit ActivityKit-Push-Benachrichtigungen

startLiveActivity

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.
live_activity.content-state	Object	Erforderlich	Inhalt für die Live Activity-Benachrichtigung.
live_activity.attributes-type	String	Erforderlich	Der Typ der in der Live Activity verwendeten Attribute.
live_activity.attributes	Object	Erforderlich	Attribute für die Live Activity.
live_activity_id	String	Erforderlich	Eine eindeutige Kennung für die Live Activity. Wird verwendet, um diese Aktivität beim Aufruf von updateLiveActivity anzusprechen. Muss pro Aktivitätssitzung eindeutig sein.
filter	String	Optional	Der Name eines Pushwoosh-Filters (Segments). Siehe Segment- / Filtername. Die Live Activity wird auf allen Geräten gestartet, die diesem Filter entsprechen.
devices	Array of Strings	Optional	Eine Liste von Geräte-Tokens. Die Live Activity wird nur auf den angegebenen Geräten gestartet.
send_date	String	Optional	Plant den Push, der die Live Activity startet, für ein bestimmtes Datum und eine bestimmte Uhrzeit – funktioniert entweder mit filter- oder devices-Targeting. Verwenden Sie das Format YYYY-MM-DD HH:mm oder now, um sofort zu starten (dies ist auch der Standard, wenn der Parameter weggelassen wird). Darf nicht mehr als 1 Tag in der Vergangenheit oder 30 Tage in der Zukunft liegen, andernfalls wird die Anfrage mit einem Validierungsfehler abgelehnt.
timezone	String	Optional	Die Zeitzone, die zur Interpretation von send_date verwendet wird. Wenn weggelassen, wird send_date in UTC interpretiert.

Vorsicht

Der Fernstart einer Live Activity über startLiveActivity erfordert iOS 17.2+ auf dem Gerät – frühere Versionen unterstützen die pushToStartTokenUpdates-API nicht, auf die dieser Endpunkt angewiesen ist. Siehe Live Activity mit einer Remote-Push-Benachrichtigung starten.

Beim Targeting auf einen filter (Segment) ist die geplante Sendezeit der Zeitpunkt, zu dem Pushwoosh mit dem Versand des Pushes beginnt, nicht ein garantierter Zustellzeitpunkt – bei großen Zielgruppen kann die Zustellung an einzelne Geräte um einige Minuten hinter send_date zurückbleiben, da die Senderate für Live Activity-Pushes nicht mit send_rate angepasst werden kann.

Anfragebeispiel

Mit Filter

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "FIRST_LIVE_ACTIVITY",
        "filter": "FILTER_NAME_1"
      }
    ]
  }
}

Mit Geräten

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "SECOND_LIVE_ACTIVITY",
        "devices": ["first_third", "second_device"]
      }
    ]
  }
}

Geplanter Start

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "THIRD_LIVE_ACTIVITY",
        "filter": "FILTER_NAME_1",
        "send_date": "2026-06-16 16:00"
      }
    ]
  }
}

Antwortbeispiel

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "XXXXX-XXXXXXXX-XXXXXXXX"
    ]
  }
}

Hinweis:

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

updateLiveActivity

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

Ermöglicht das Aktualisieren und Beenden 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.
live_activity.event	String	Erforderlich	Gibt den Ereignistyp an. Verwenden Sie "update", um die Live Activity zu aktualisieren, oder "end", um sie zu schließen.
live_activity.content-state	Object	Erforderlich	Objekt mit Schlüssel-Wert-Paaren, das verwendet wird, um Daten an die Live Activity zur Aktualisierung ihres Inhalts zu übergeben.
live_activity.dismissal-date	Integer	Optional	Die Zeit (in Sekunden), zu der die Live Activity enden soll.
live_activity_id	String	Erforderlich	Die eindeutige Kennung der zu aktualisierenden Live Activity. Muss mit der in startLiveActivity verwendeten live_activity_id übereinstimmen. Das Update wird an alle Geräte ausgeliefert, auf denen diese Aktivität gestartet wurde.
live_activity.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).
live_activity.stale-date	Integer	Optional	Die Zeit (in Sekunden), die das Datum darstellt, an dem eine Live Activity veraltet oder nicht mehr aktuell ist.

Anfragebeispiel

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "live_activity": {
          "event": "update",
          "title": "Live Activity Update",
          "content-state": {
            "status": "second 66",
            "estimatedTime": "66 min",
            "emoji": "👨‍"
          },
          "relevance-score": 60
        },
        "live_activity_id": "FIRST_LIVE_ACTIVITY"
      }
    ]
  }
}

Antwortbeispiel

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "XXXXX-XXXXXXXX-XXXXXXXX"
    ]
  }
}

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

Mehrere Aktivitäten pro Gerät

Sie können mehrere Live Activities auf demselben Gerät starten, indem Sie startLiveActivity mehrmals mit unterschiedlichen live_activity_id-Werten aufrufen.

Wenn Sie beispielsweise zwei Aktivitäten starten: FIRST_LIVE_ACTIVITY mit filter: FILTER_NAME_1 und SECOND_LIVE_ACTIVITY mit filter: FILTER_NAME_2, wird ein Gerät, das beiden Filtern entspricht, beide Aktivitäten gleichzeitig ausführen.

Um eine davon zu aktualisieren, übergeben Sie ihre live_activity_id an updateLiveActivity. Das Update wird an alle Geräte ausgeliefert, auf denen diese Aktivität erstellt wurde. Die andere Aktivität ist nicht betroffen.

Der Parameter relevance-score steuert die Anzeigepriorität, wenn mehrere Live Activities auf demselben Gerät aktiv sind. Wenn der Bildschirmplatz begrenzt ist oder Aktivitäten gruppiert sind, wird die Aktivität mit einem höheren Wert mit höherer Priorität angezeigt.