Skip to content

Actualizar la actividad en directo

post

/messages/live_activity/update

Utilice este punto final para actualizar y finalizar las Actividades en Directo mostradas por su aplicación iOS. Este punto final requiere una configuración adicional.

Después de registrar una Live Activity, puede pasar una carga JSON para actualizar su servicio de Notificaciones Push de Apple (APNs). Para más información, consulte la documentación de Apple sobre la actualización de Live Activity con cargas útiles de notificaciones push.

See me in Postman

Requisitos previos

Para utilizar este punto final, tendrás que completar lo siguiente:

  • Generar una clave API con el permiso messages.live_activity.update.
  • Registra una actividad en vivo de forma remota o local utilizando el SDK Swift de Braze.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

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."
 }

Parámetros de la solicitud

Ejemplo de solicitud

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"
        }
    }
}'

Respuesta

Hay dos respuestas de código de estado para este punto final: 201 y 4XX.

Ejemplo de respuesta positiva

Se devuelve un código de estado 201 si la solicitud se ha formateado correctamente y la hemos recibido. El código de estado 201 podría devolver el siguiente cuerpo de respuesta.

1
2
3

{
  "message": "success"
}

Ejemplo de respuesta de error

La clase de código de estado 4XX indica un error del cliente. Consulte el artículo Errores y respuestas de la API para obtener más información sobre los errores que puede encontrar.

El código de estado 400 podría devolver el siguiente cuerpo de respuesta.

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' "
}
Github   Editar esta página en GitHub
¿QUÉ TAN ÚTIL FUE ESTA PÁGINA?
New Stuff!