API de iOS Live Activities

Documentação da Apple:

Sobre Live Activities

Atualizando e encerrando Live Activities com notificações push do ActivityKit

startLiveActivity

Use este método para criar iOS Live Activities.

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

Permite criar iOS Live Activities.

Request body

Parâmetro	Tipo	Obrigatório/Opcional	Descrição
application	String	Obrigatório	Código da aplicação Pushwoosh
auth	String	Obrigatório	Token de acesso à API do Painel de Controle Pushwoosh.
notifications	Array	Obrigatório	Array JSON de parâmetros da mensagem. Veja detalhes na tabela Notificações abaixo.

Notificações

Parâmetros usados no array notifications:

Parâmetro	Tipo	Obrigatório/Opcional	Descrição
content	String	Obrigatório	Conteúdo de fallback para dispositivos rodando versões do iOS anteriores a 16.1 que não suportam Live Activity. No iOS 16.1+ (com suporte a Live Activity), o conteúdo é obtido do campo `live_activity`.
title	String	Opcional	O título da mensagem de notificação.
live_activity	Object	Obrigatório	Dados da Live Activity para criar a Live Activity no iOS.
content-state	Object	Obrigatório	Conteúdo para a notificação da Live Activity.
attributes-type	String	Obrigatório	O tipo de atributos usados na Live Activity.
attributes	Object	Obrigatório	Atributos para a Live Activity.
live_activity_id	String	Obrigatório	Um ID único para a Live Activity, criado pelo usuário.
filter_code	String	Opcional	Código de Filtro (Segmento) para segmentar audiências específicas.
devices	Array de strings	Opcional	Tokens ou HWIDs para enviar notificações push direcionadas, com um máximo de 1000. Se definido, a mensagem será enviada apenas para os dispositivos na lista. Nota: O Application Group para a lista de dispositivos não é permitido, e tokens push do iOS devem estar em letras minúsculas.
users	Array de strings	Opcional	Se definido, a mensagem será entregue apenas para os User IDs especificados (atribuídos via chamada `/registerUser`). Você pode incluir até 1000 IDs de usuário no array. Nota: Se usado junto com o parâmetro `devices`, o parâmetro `users` terá precedência. Application Group para a lista de usuários não é permitido.

Response

200

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

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // obrigatório. Código da aplicação Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "notifications": [{
      "live_activity": {                 // obrigatório. Dados da Live Activity para criar a Live Activity no iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // opcional. Identificador único da Live Activity.
      "filter_code": "FILTER_NAME",      // opcional. Especifique o filtro.
      "devices": [                       // opcional. Especifique tokens ou hwids para enviar push direcionado.
          "hwid_XXXX"                    //           Não mais que 1000 tokens/hwids em um array.
      ],                                 //           Se definido, a mensagem será enviada apenas para
                                         //           os dispositivos na lista. Application Group para
                                         //           lista de dispositivos não é permitido.
                                         //           Tokens push do iOS devem ser apenas letras minúsculas.
      "users": [                         // opcional. Se definido, a mensagem será entregue apenas para
        "user_XXXX"                      //           os IDs de usuário especificados (definidos via chamada /registerUser).
      ]                                  //           Se especificado junto com o parâmetro devices, este último será
                                         //           ignorado. Não mais que 1000 IDs de usuário em um array.
                                         //           Application Group para lista de usuários não é permitido.
    }]
  }
}

Nota:

Leia este artigo para saber mais sobre como trabalhar com Live Activities usando o SDK iOS da Pushwoosh.

updateLiveActivity

Use este método para gerenciar iOS Live Activities.

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

Permite criar e gerenciar iOS Live Activities.

Request body

Parâmetro	Tipo	Obrigatório/Opcional	Descrição
auth	String	Obrigatório	Token de acesso à API do Painel de Controle Pushwoosh.
application	String	Obrigatório	Código da aplicação Pushwoosh
notifications	Array	Obrigatório	Array JSON de parâmetros da mensagem. Veja detalhes na tabela Notificações abaixo.

Notificações

Parâmetros usados no array notifications:

Parâmetro	Tipo	Obrigatório/Opcional	Descrição
live_activity	Object	Obrigatório	Dados da Live Activity para atualizar a Live Activity no iOS.
event	String	Obrigatório	Especifica o tipo de evento. Use `"update"` para atualizar a Live Activity ou `"end"` para encerrá-la.
content-state	Object	Obrigatório	Objeto com pares chave-valor usados para passar dados para a Live Activity para atualizar seu conteúdo.
dismissal-date	Integer	Opcional	O horário (em segundos) quando a Live Activity deve terminar.
live_activity_id	String	Obrigatório	Um identificador único para a Live Activity sendo atualizada.
stale-date	Integer	Opcional	O horário (em segundos) que representa a data em que uma Live Activity se torna obsoleta (stale).

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

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // obrigatório. Código da aplicação Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "notifications": [{
      "live_activity": {                 // obrigatório. Dados da Live Activity para atualizar a Live Activity no iOS
        "event": "update",               // obrigatório. Use "update" para atualizar a Live Activity ou
                                         //           "end" para fechar a Live Activity
        "content-state": {               // obrigatório. Objeto com pares chave-valor usados para passar dados
          "courierName": "NUMBER: 15",   //           para a Live Activity para atualizar seu conteúdo
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // opcional. Horário de término da Live Activity em segundos
        "stale-date": 23456789           // opcional. Horário (em segundos) quando a Live Activity se torna obsoleta
      },
      "live_activity_id": "unique UUID"  // opcional. Identificador único da Live Activity.
    }]
  }
}

Leia este artigo para saber mais sobre como trabalhar com Live Activities usando o SDK iOS da Pushwoosh.