API de Live Activities de iOS

Documentación de Apple:

Acerca de las Live Activities

Actualizar y finalizar Live Activities con notificaciones push de ActivityKit

startLiveActivity

Usa este método para crear Live Activities de iOS.

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

Permite crear Live Activities de iOS.

Cuerpo de la solicitud

Parámetro	Tipo	Requerido/Opcional	Descripción
application	String	Requerido	Código de aplicación de Pushwoosh
auth	String	Requerido	Token de acceso a la API desde el Panel de Control de Pushwoosh.
notifications	Array	Requerido	Array JSON de parámetros de mensaje. Consulta los detalles en la tabla de Notificaciones a continuación.

Notificaciones

Parámetros utilizados en el array notifications:

Parámetro	Tipo	Requerido/Opcional	Descripción
content	String	Requerido	Contenido de respaldo para dispositivos con versiones de iOS inferiores a la 16.1 que no admiten Live Activity. En iOS 16.1+ (con soporte para Live Activity), el contenido se obtiene del campo `live_activity`.
title	String	Opcional	El título del mensaje de notificación.
live_activity	Object	Requerido	Datos de Live Activity para crear una Live Activity en iOS.
content-state	Object	Requerido	Contenido para la notificación de Live Activity.
attributes-type	String	Requerido	El tipo de atributos utilizados en la Live Activity.
attributes	Object	Requerido	Atributos para la Live Activity.
live_activity_id	String	Requerido	Un ID único para la Live Activity, creado por el usuario.
filter_code	String	Opcional	Código de Filtro (Segmento) para dirigirse a segmentos de audiencia específicos.
devices	Array of strings	Opcional	Tokens o HWIDs para enviar notificaciones push dirigidas, con un máximo de 1000. Si se establece, el mensaje se enviará solo a los dispositivos de la lista. Nota: No se permite el Grupo de Aplicaciones para la lista de dispositivos, y los tokens push de iOS deben estar en minúsculas.
users	Array of strings	Opcional	Si se establece, el mensaje solo se entregará a los ID de Usuario especificados (asignados a través de la llamada `/registerUser`). Puedes incluir hasta 1000 ID de usuario en el array. Nota: Si se usa junto con el parámetro `devices`, el parámetro `users` tendrá prioridad. No se permite el Grupo de Aplicaciones para la lista de usuarios.

Respuesta

200

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

Ejemplo de solicitud

{
  "request": {
    "application": "XXXXX-XXXXX",        // requerido. Código de aplicación de Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requerido. Datos de Live Activity para crear una Live Activity en iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // opcional. Identificador único de la Live Activity.
      "filter_code": "FILTER_NAME",      // opcional. Especifica el filtro.
      "devices": [                       // opcional. Especifica tokens o hwids para enviar push dirigidos
          "hwid_XXXX"                    //           notificaciones. No más de 1000 tokens/hwids en
      ],                                 //           un array. Si se establece, el mensaje solo se enviará a
                                         //           los dispositivos de la lista. El Grupo de Aplicaciones para
                                         //           la lista de dispositivos no está permitido.
                                         //           Los tokens push de iOS solo pueden estar en minúsculas.
      "users": [                         // opcional. Si se establece, el mensaje solo se entregará a los
        "user_XXXX"                      //           ID de usuario especificados (establecidos mediante la llamada /registerUser). Si se especifica
      ]                                  //           junto con el parámetro de dispositivos, este último será
                                         //           ignorado. No más de 1000 ID de usuario en un array.
                                         //           El Grupo de Aplicaciones para la lista de usuarios no está permitido.
    }]
  }
}

Nota:

Lee este artículo para aprender más sobre cómo trabajar con Live Activities usando el SDK de Pushwoosh para iOS.

updateLiveActivity

Usa este método para gestionar Live Activities de iOS.

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

Permite crear y gestionar Live Activities de iOS.

Cuerpo de la solicitud

Parámetro	Tipo	Requerido/Opcional	Descripción
auth	String	Requerido	Token de acceso a la API desde el Panel de Control de Pushwoosh.
application	String	Requerido	Código de aplicación de Pushwoosh
notifications	Array	Requerido	Array JSON de parámetros de mensaje. Consulta los detalles en la tabla de Notificaciones a continuación.

Notificaciones

Parámetros utilizados en el array notifications:

Parámetro	Tipo	Requerido/Opcional	Descripción
live_activity	Object	Requerido	Datos de Live Activity para actualizar una Live Activity en iOS.
event	String	Requerido	Especifica el tipo de evento. Usa `"update"` para actualizar la Live Activity o `"end"` para cerrarla.
content-state	Object	Requerido	Objeto con pares clave-valor utilizado para pasar datos a la Live Activity para actualizar su contenido.
dismissal-date	Integer	Opcional	El tiempo (en segundos) en el que la Live Activity debe finalizar.
live_activity_id	String	Requerido	Un identificador único para la Live Activity que se está actualizando.
relevance-score	Integer	Opcional	Indica al sistema iOS qué Live Activity tiene mayor prioridad que otras. Acepta valores de 1 al infinito (se recomiendan valores hasta 100).
stale-date	Integer	Opcional	El tiempo (en segundos) que representa la fecha en la que una Live Activity se vuelve obsoleta o caducada.

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

Ejemplo de solicitud

{
  "request": {
    "application": "XXXXX-XXXXX",        // requerido. Código de aplicación de Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requerido. Datos de Live Activity para actualizar una Live Activity en iOS
        "event": "update",               // requerido. Usa "update" para actualizar la Live Activity o
                                         //           "end" para cerrar la Live Activity
        "content-state": {               // requerido. Objeto con pares clave-valor utilizado para pasar datos
          "courierName": "NUMBER: 15",   //           a la Live Activity para actualizar su contenido
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // opcional. Tiempo de finalización de la Live Activity en segundos
        "relevance-score": 50,           // opcional. Prioridad para la Live Activity (se recomienda de 1 a 100)
        "stale-date": 23456789           // opcional. Tiempo (en segundos) en que la Live Activity se vuelve obsoleta
      },
      "live_activity_id": "unique UUID"  // opcional. Identificador único de la Live Activity.
    }]
  }
}

Lee este artículo para aprender más sobre cómo trabajar con Live Activities usando el SDK de Pushwoosh para iOS.