API de Live Activities do iOS

Documentação da Apple:

Sobre Live Activities

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

startLiveActivity

Use este método para criar Live Activities do iOS.

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

Permite criar Live Activities do iOS.

Corpo da solicitação

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 da Pushwoosh.
notifications	Array	Obrigatório	Array JSON de parâmetros de mensagem. Veja os detalhes na tabela de 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 com versões do iOS abaixo de 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 uma 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 exclusivo para a Live Activity, criado pelo usuário.
filter_code	String	Opcional	Código do Filtro (Segmento) para direcionar segmentos de público específicos.
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 Grupo de Aplicações para a lista de dispositivos não é permitido, e os tokens push do iOS devem estar em minúsculas.
users	Array de strings	Opcional	Se definido, a mensagem será entregue apenas aos IDs de Usuário especificados (atribuídos através da chamada `/registerUser`). Você pode incluir até 1000 IDs de usuário no array. Nota: Se usado em conjunto com o parâmetro `devices`, o parâmetro `users` terá precedência. O Grupo de Aplicações para a lista de usuários não é permitido.

Resposta

200

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

Exemplo de solicitação

{
  "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 da Pushwoosh
    "notifications": [{
      "live_activity": {                 // obrigatório. Dados da Live Activity para criar uma 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 pushes direcionados
          "hwid_XXXX"                    //           notificações. Não mais que 1000 tokens/hwids em
      ],                                 //           um array. Se definido, a mensagem será enviada apenas para
                                         //           os dispositivos na lista. O Grupo de Aplicações para
                                         //           a lista de dispositivos não é permitido.
                                         //           Os tokens push do iOS só podem estar em minúsculas.
      "users": [                         // opcional. Se definido, a mensagem será entregue apenas aos especificados
        "user_XXXX"                      //           IDs de usuário (definidos via chamada /registerUser). Se especificado
      ]                                  //           juntamente com o parâmetro devices, este último será
                                         //           ignorado. Não mais que 1000 IDs de usuário em um array.
                                         //           O Grupo de Aplicações para a lista de usuários não é permitido.
    }]
  }
}

Nota:

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

updateLiveActivity

Use este método para gerenciar Live Activities do iOS.

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

Permite criar e gerenciar Live Activities do iOS.

Corpo da solicitação

Parâmetro	Tipo	Obrigatório/Opcional	Descrição
auth	String	Obrigatório	Token de acesso à API do Painel de Controle da Pushwoosh.
application	String	Obrigatório	Código da aplicação Pushwoosh
notifications	Array	Obrigatório	Array JSON de parâmetros de mensagem. Veja os detalhes na tabela de 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 uma Live Activity no iOS.
event	String	Obrigatório	Especifica o tipo de evento. Use `"update"` para atualizar a Live Activity ou `"end"` para fechá-la.
content-state	Object	Obrigatório	Objeto com pares de chave-valor usado para passar dados para a Live Activity para atualizar seu conteúdo.
dismissal-date	Integer	Opcional	O tempo (em segundos) em que a Live Activity deve terminar.
live_activity_id	String	Obrigatório	Um identificador único para a Live Activity que está sendo atualizada.
relevance-score	Integer	Opcional	Informa ao sistema iOS qual Live Activity tem prioridade maior que as outras. Aceita valores de 1 ao infinito (valores até 100 são recomendados).
stale-date	Integer	Opcional	O tempo (em segundos) que representa a data em que uma Live Activity se torna obsoleta, ou desatualizada.

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

Exemplo de solicitação

{
  "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 da Pushwoosh
    "notifications": [{
      "live_activity": {                 // obrigatório. Dados da Live Activity para atualizar uma 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 de chave-valor usado para passar dados
          "courierName": "NUMBER: 15",   //           para a Live Activity para atualizar seu conteúdo
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // opcional. Tempo de término da Live Activity em segundos
        "relevance-score": 50,           // opcional. Prioridade para a Live Activity (recomendado de 1 a 100)
        "stale-date": 23456789           // opcional. Tempo (em segundos) em que 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 do Pushwoosh para iOS.