API Live Activities iOS

Documentation Apple :

À propos des Live Activities

Mise à jour et fin des Live Activities avec les notifications push d’ActivityKit

startLiveActivity

Utilisez cette méthode pour créer des Live Activities iOS.

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

Permet de créer des Live Activities iOS.

Corps de la requête

Paramètre	Type	Requis/Optionnel	Description
application	String	Requis	Code d’application Pushwoosh
auth	String	Requis	Jeton d’accès à l’API depuis le Control Panel de Pushwoosh.
notifications	Array	Requis	Tableau JSON des paramètres de message. Voir les détails dans le tableau Notifications ci-dessous.

Notifications

Paramètres utilisés dans le tableau notifications :

Paramètre	Type	Requis/Optionnel	Description
content	String	Requis	Contenu de repli pour les appareils exécutant des versions d’iOS inférieures à 16.1 qui ne prennent pas en charge les Live Activities. Sur iOS 16.1+ (avec prise en charge des Live Activities), le contenu provient du champ `live_activity`.
title	String	Optionnel	Le titre du message de notification.
live_activity	Object	Requis	Données de la Live Activity pour créer une Live Activity dans iOS.
content-state	Object	Requis	Contenu pour la notification de la Live Activity.
attributes-type	String	Requis	Le type d’attributs utilisé dans la Live Activity.
attributes	Object	Requis	Attributs pour la Live Activity.
live_activity_id	String	Requis	Un ID unique pour la Live Activity, créé par l’utilisateur.

Réponse

200

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

Exemple de requête

{
  "request": {
    "application": "XXXXX-XXXXX",        // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // requis. Jeton d'accès à l'API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requis. Données de la Live Activity pour créer une Live Activity dans iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // optionnel. Identifiant unique de la Live Activity.
    }]
  }
}

Remarque :

Lisez cet article pour en savoir plus sur l’utilisation des Live Activities avec le SDK iOS de Pushwoosh.

updateLiveActivity

Utilisez cette méthode pour gérer les Live Activities iOS.

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

Permet de créer et de gérer les Live Activities iOS.

Corps de la requête

Paramètre	Type	Requis/Optionnel	Description
auth	String	Requis	Jeton d’accès à l’API depuis le Control Panel de Pushwoosh.
application	String	Requis	Code d’application Pushwoosh
notifications	Array	Requis	Tableau JSON des paramètres de message. Voir les détails dans le tableau Notifications ci-dessous.

Notifications

Paramètres utilisés dans le tableau notifications :

Paramètre	Type	Requis/Optionnel	Description
live_activity	Object	Requis	Données de la Live Activity pour mettre à jour une Live Activity dans iOS.
event	String	Requis	Spécifie le type d’événement. Utilisez `"update"` pour mettre à jour la Live Activity ou `"end"` pour la fermer.
content-state	Object	Requis	Objet avec des paires clé-valeur utilisé pour transmettre des données à la Live Activity afin de mettre à jour son contenu.
dismissal-date	Integer	Optionnel	L’heure (en secondes) à laquelle la Live Activity doit se terminer.
live_activity_id	String	Requis	Un identifiant unique pour la Live Activity en cours de mise à jour.
relevance-score	Integer	Optionnel	Indique au système iOS quelle Live Activity a une priorité plus élevée que les autres. Accepte des valeurs de 1 à l’infini (les valeurs jusqu’à 100 sont recommandées).
stale-date	Integer	Optionnel	L’heure (en secondes) qui représente la date à laquelle une Live Activity devient obsolète ou périmée.

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

Exemple de requête

{
  "request": {
    "application": "XXXXX-XXXXX",        // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // requis. Jeton d'accès à l'API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requis. Données de la Live Activity pour mettre à jour une Live Activity dans iOS
        "event": "update",               // requis. Utilisez "update" pour mettre à jour la Live Activity ou
                                         //           "end" pour fermer la Live Activity
        "content-state": {               // requis. Objet avec des paires clé-valeur utilisé pour transmettre des données
          "courierName": "NUMBER: 15",   //           à la Live Activity pour mettre à jour son contenu
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // optionnel. Heure de fin de la Live Activity en secondes
        "relevance-score": 50,           // optionnel. Priorité pour la Live Activity (1 à 100 recommandé)
        "stale-date": 23456789           // optionnel. Heure (en secondes) à laquelle la Live Activity devient obsolète
      },
      "live_activity_id": "unique UUID"  // optionnel. Identifiant unique de la Live Activity.
    }]
  }
}

Lisez cet article pour en savoir plus sur l’utilisation des Live Activities avec le SDK iOS de Pushwoosh.