API de Live Activities de iOS

Documentación de Apple:

Acerca de Live Activities

Actualizar y finalizar Live Activities con notificaciones push de ActivityKit

startLiveActivity

Utilice 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 del Panel de Control de Pushwoosh.
notifications	Array	Requerido	Array JSON de parámetros del mensaje. Vea 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 16.1 que no soportan 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 la 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 de 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 Application Group para la lista de dispositivos, y los tokens push de iOS deben estar en minúsculas.
users	Array de strings	Opcional	Si se establece, el mensaje solo se entregará a los User IDs especificados (asignados a través de la llamada `/registerUser`). Puede incluir hasta 1000 IDs 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 Application Group 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 del Panel de Control de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requerido. Datos de Live Activity para crear la 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. Especificar filtro.
      "devices": [                       // opcional. Especificar tokens o hwids para enviar push dirigidos.
          "hwid_XXXX"                    //           No más de 1000 tokens/hwids en un array.
      ],                                 //           Si se establece, el mensaje solo se enviará a
                                         //           los dispositivos en la lista. No se permite
                                         //           Application Group para la lista de dispositivos.
                                         //           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"                      //           IDs de usuario especificados (establecidos vía llamada /registerUser).
      ]                                  //           Si se especifica junto con el parámetro devices, este último
                                         //           será ignorado. No más de 1000 IDs de usuario en un array.
                                         //           No se permite Application Group para la lista de usuarios.
    }]
  }
}

Nota:

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

updateLiveActivity

Utilice 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 del Panel de Control de Pushwoosh.
application	String	Requerido	Código de aplicación de Pushwoosh
notifications	Array	Requerido	Array JSON de parámetros del mensaje. Vea 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 la Live Activity en iOS.
event	String	Requerido	Especifica el tipo de evento. Use `"update"` para actualizar la Live Activity o `"end"` para cerrarla.
content-state	Object	Requerido	Objeto con pares clave-valor utilizados para pasar datos a la Live Activity para actualizar su contenido.
dismissal-date	Integer	Opcional	El tiempo (en segundos) cuando la Live Activity debe finalizar.
live_activity_id	String	Requerido	Un identificador único para la Live Activity que se está actualizando.
stale-date	Integer	Opcional	El tiempo (en segundos) que representa la fecha en la que una Live Activity se vuelve obsoleta o caduca.

{
  "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 del Panel de Control de Pushwoosh
    "notifications": [{
      "live_activity": {                 // requerido. Datos de Live Activity para actualizar la Live Activity en iOS
        "event": "update",               // requerido. Use "update" para actualizar Live Activity o
                                         //           "end" para cerrar Live Activity
        "content-state": {               // requerido. Objeto con pares clave-valor utilizados 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 Live Activity en segundos
        "stale-date": 23456789           // opcional. Tiempo (en segundos) cuando la Live Activity se vuelve obsoleta
      },
      "live_activity_id": "unique UUID"  // opcional. Identificador único de la Live Activity.
    }]
  }
}

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