API iOS Live Activities

Documentation Apple :

À propos des Activités en direct

Mise à jour et fin des Activités en direct avec les notifications push ActivityKit

startLiveActivity

Utilisez cette méthode pour créer des Activités en direct iOS.

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

Permet de créer des Activités en direct iOS.

Corps de la requête

Paramètre	Type	Requis/Facultatif	Description
application	String	Requis	Code d’application Pushwoosh
auth	String	Requis	Token d’accès API depuis le Panneau de configuration Pushwoosh.
notifications	Array	Requis	Tableau JSON de 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/Facultatif	Description
content	String	Requis	Contenu de repli pour les appareils exécutant des versions iOS inférieures à 16.1 qui ne prennent pas en charge les Activités en direct. Sur iOS 16.1+ (avec prise en charge des Activités en direct), le contenu provient du champ `live_activity`.
title	String	Facultatif	Le titre du message de notification.
live_activity	Object	Requis	Données de l’Activité en direct pour créer l’Activité en direct dans iOS.
content-state	Object	Requis	Contenu pour la notification d’Activité en direct.
attributes-type	String	Requis	Le type d’attributs utilisés dans l’Activité en direct.
attributes	Object	Requis	Attributs pour l’Activité en direct.
live_activity_id	String	Requis	Un ID unique pour l’Activité en direct, créé par l’utilisateur.
filter_code	String	Facultatif	Code de filtre (Segment) pour cibler des segments d’audience spécifiques.
devices	Tableau de chaînes	Facultatif	Tokens ou HWIDs pour envoyer des notifications push ciblées, avec un maximum de 1000. Si défini, le message sera envoyé uniquement aux appareils de la liste. Remarque : Le Groupe d’applications pour la liste des appareils n’est pas autorisé, et les tokens push iOS doivent être en minuscules.
users	Tableau de chaînes	Facultatif	Si défini, le message sera livré uniquement aux ID utilisateurs spécifiés (assignés via l’appel `/registerUser`). Vous pouvez inclure jusqu’à 1000 ID utilisateurs dans le tableau. Remarque : Si utilisé conjointement avec le paramètre `devices`, le paramètre `users` aura la priorité. Le Groupe d’applications pour la liste des utilisateurs n’est pas autorisé.

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. Token d'accès API depuis le Panneau de configuration Pushwoosh
    "notifications": [{
      "live_activity": {                 // requis. Données Live Activity pour créer l'Activité en direct dans iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // facultatif. Identifiant unique de l'Activité en direct.
      "filter_code": "FILTER_NAME",      // facultatif. Spécifier le filtre.
      "devices": [                       // facultatif. Spécifier les tokens ou hwids pour envoyer des notifications
          "hwid_XXXX"                    //           push ciblées. Pas plus de 1000 tokens/hwids dans
      ],                                 //           un tableau. Si défini, le message sera envoyé uniquement
                                         //           aux appareils de la liste. Le Groupe d'applications pour
                                         //           la liste des appareils n'est pas autorisé.
                                         //           Les tokens push iOS doivent être uniquement en minuscules.
      "users": [                         // facultatif. Si défini, le message sera livré uniquement aux
        "user_XXXX"                      //           ID utilisateurs spécifiés (définis via l'appel /registerUser). Si spécifié
      ]                                  //           avec le paramètre devices, ce dernier sera
                                         //           ignoré. Pas plus de 1000 ID utilisateurs dans un tableau.
                                         //           Le Groupe d'applications pour la liste des utilisateurs n'est pas autorisé.
    }]
  }
}

Remarque :

Lisez cet article pour en savoir plus sur l’utilisation des Activités en direct avec le SDK iOS Pushwoosh.

updateLiveActivity

Utilisez cette méthode pour gérer les Activités en direct iOS.

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

Permet de créer et gérer les Activités en direct iOS.

Corps de la requête

Paramètre	Type	Requis/Facultatif	Description
auth	String	Requis	Token d’accès API depuis le Panneau de configuration Pushwoosh.
application	String	Requis	Code d’application Pushwoosh
notifications	Array	Requis	Tableau JSON de 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/Facultatif	Description
live_activity	Object	Requis	Données de l’Activité en direct pour mettre à jour l’Activité en direct dans iOS.
event	String	Requis	Spécifie le type d’événement. Utilisez `"update"` pour mettre à jour l’Activité en direct ou `"end"` pour la fermer.
content-state	Object	Requis	Objet avec des paires clé-valeur utilisé pour passer des données à l’Activité en direct pour mettre à jour son contenu.
dismissal-date	Integer	Facultatif	L’heure (en secondes) à laquelle l’Activité en direct doit se terminer.
live_activity_id	String	Requis	Un identifiant unique pour l’Activité en direct en cours de mise à jour.
stale-date	Integer	Facultatif	L’heure (en secondes) qui représente la date à laquelle une Activité en direct 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. Token d'accès API depuis le Panneau de configuration Pushwoosh
    "notifications": [{
      "live_activity": {                 // requis. Données Live Activity pour mettre à jour l'Activité en direct dans iOS
        "event": "update",               // requis. Utilisez "update" pour mettre à jour l'Activité en direct ou
                                         //           "end" pour fermer l'Activité en direct
        "content-state": {               // requis. Objet avec des paires clé-valeur utilisé pour passer des données
          "courierName": "NUMBER: 15",   //           à l'Activité en direct pour mettre à jour son contenu
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // facultatif. Heure de fin de l'Activité en direct en secondes
        "stale-date": 23456789           // facultatif. Heure (en secondes) à laquelle l'Activité en direct devient obsolète
      },
      "live_activity_id": "unique UUID"  // facultatif. Identifiant unique de l'Activité en direct.
    }]
  }
}

Lisez cet article pour en savoir plus sur l’utilisation des Activités en direct avec le SDK iOS Pushwoosh.