Skip to content

Démarrer une ligne/en production/instantanée

post

/messages/live_activity/start

Utilisez cet endpoint pour démarrer à distance les activités en direct affichées dans votre app iOS. Cet endpoint nécessite une configuration supplémentaire.

Après avoir créé une activité en direct, vous pouvez effectuer une requête POST pour démarrer à distance votre activité pour n’importe quel segment/instantané. Pour en savoir plus sur les activités en direct d’Apple, consultez Démarrage et mise à jour des activités en direct avec les notifications push d’ActivityKit.

Conditions préalables

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

Limite de débit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Corps de la demande

Paramètres de demande

Paramètre Requis Type de données Description
app_id Requis Chaîne de caractères Identifiant API récupéré depuis la page Clés API.
activity_id Requis Chaîne de caractères Définissez une chaîne de caractères personnalisée comme votre activity_id. Vous utiliserez cet ID lorsque vous souhaiterez envoyer des événements de mise à jour ou de fin à votre ligne/en production/instantanée.
activity_attributes_type Requis Chaîne de caractères Le type d’attributs d’activité que vous définissez à l’adresse liveActivities.registerPushToStart dans votre application.
activity_attributes Requis Objet Les valeurs d’attributs statiques pour le type d’activité (comme les noms des équipes sportives, qui ne changent pas).
content_state Requis Objet Vous définissez les paramètres ContentState lorsque vous créez votre activité en direct. Transmettez les valeurs mises à jour pour votre ContentState en utilisant cet objet.

Le format de cette requête doit correspondre à la forme que vous avez initialement définie.
dismissal_date Facultatif DateTime
chaîne (ISO-8601 )
Ce paramètre définit le moment de suppression de l’activité en direct de l’interface utilisateur.
stale_date Facultatif DateTime
chaîne (ISO-8601 )
Ce paramètre indique au système quand le contenu de l’activité en direct devient obsolète dans l’interface utilisateur.
notification Requis Objet Inclure un apple_push objet pour définir une notification push. Le comportement de cette notification push dépend du fait que l’utilisateur soit actif ou utilise un appareil proxy.
  • Si un notification est inclus et que l’utilisateur est actif sur son iPhone lorsque la mise à jour est livrée, l’interface utilisateur de l’activité en direct mise à jour glissera vers le bas et s’affichera comme une notification push.
  • Si un notification est inclus et que l’utilisateur n’est pas actif sur son iPhone, son écran s’allume pour afficher l’interface utilisateur de l’activité en direct mise à jour sur son écran de verrouillage.
  • Le paramètre notification alert ne s’affichera pas comme une notification push standard. De plus, si un utilisateur dispose d’un appareil proxy, comme une Apple Watch, le alert s’affichera ici.
external_user_ids Facultatif si segment_id ou audience est fourni Tableau de chaînes de caractères Voir ID externe.
segment_id Facultatif si external_user_ids ou audience est fourni Chaîne de caractères Voir identifiant de segmentation.
custom_audience Facultatif si external_user_ids ou segment_id est fourni Objet Audience connectée Voir audience connectée.

Exemple de demande

Réponse

Deux réponses de code de statut 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é formatée correctement et que nous l’avons reçue. Le code de statut 201 pourrait renvoyer le corps de réponse suivant.

Exemple de réponse échouée

La classe du 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.

CETTE PAGE A-T-ELLE ÉTÉ UTILE?
New Stuff!