Mettre à jour l’activité en direct

Utilisez cet endpoint pour mettre à jour et terminer les activités en direct affichées par votre application iOS. Cet endpoint nécessite une configuration supplémentaire.

Après avoir enregistré une activité en direct, vous pouvez transmettre un payload JSON pour mettre à jour votre service de notification push Apple (APNs). Consultez la documentation d’Apple sur la mise à jour de votre activité en direct avec des payloads de notification push pour plus d’informations.

Si content-available n’est pas défini, la priorité par défaut du service de notification push Apple (APNs) est 10. Si content-available est défini, cette priorité est de 5. Consultez l’objet push Apple pour plus de détails.

Conditions préalables

Pour utiliser cet endpoint, vous devrez effectuer les opérations suivantes :

• Générer une clé API avec l’autorisation messages.live_activity.update.
• Enregistrer une activité en direct à distance ou localement à l’aide du SDK Braze Swift.

Important

Si la charge utile finale est plus grande que la taille maximale autorisée par le service correspondant, l’envoi n’aboutira pas.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la requête

1
2
3
4
5
6
7
8
9
{
   "app_id": "(required, string) App API identifier retrieved from the Developer Console.",
   "activity_id": "(required, string) When you register your Live Activity using launchActivity, you use the pushTokenTag parameter to name the Activity’s push token to a custom string. Set activity_id to this custom string to define which Live Activity you want to update.",
   "content_state": "(required, object) You define the ContentState parameters when you create your Live Activity. Pass the updated values for your ContentState using this object. The format of this request must match the shape you initially defined.",
   "end_activity": "(optional, boolean) If true, this request ends the Live Activity.",
   "dismissal_date": "(optional, datetime in ISO-8601 format) The time to remove the Live Activity from the user’s UI. If this time is in the past, the Live Activity will be removed immediately.",
   "stale_date": "(optional, datetime in ISO-8601 format) The time the Live Activity content is marked as outdated in the user’s UI.",
   "notification": "(optional, object ) Include an `apple_push` object to define a push notification that creates an alert for the user."
 }

Request parameters

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl --location --request POST 'https://rest.iad-01.braze.com/messages/live_activity/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR-REST-API-KEY}' \
--data-raw '{
    "app_id": "{YOUR-APP-API-IDENTIFIER}",
    "activity_id": "live-activity-1",
    "content_state": {
        "teamOneScore": 2,
        "teamTwoScore": 4
    },
    "end_activity": false,
    "dismissal_date": "2023-02-28T00:00:00+0000",
    "stale_date": "2023-02-27T16:55:49+0000",
    "notification": {
        "alert": {
            "body": "It's halftime! Let's look at the scores",
            "title": "Halftime"
        }
    }
}'

Réponse

Deux codes de statut de réponse existent pour cet endpoint : 201 et 4XX.

Exemple de réponse réussie

Un code de statut 201 est renvoyé si la requête a été correctement formatée et que nous l’avons reçue. Le code de statut 201 pourrait renvoyer le corps de réponse suivant.

1
2
3
{
  "message": "success"
}

Exemple de réponse en erreur

La classe de code de statut 4XX indique une erreur client. Reportez-vous à l’article Erreurs et réponses de l’API pour plus d’informations sur les erreurs que vous pouvez rencontrer.

Le code de statut 400 pourrait renvoyer le corps de réponse suivant.

1
2
3
{
    "error": "\nProblem:\n  message body does not match declared format\nResolution:\n  when specifying application/json as content-type, you must pass valid application/json in the request's 'body' "
}