API для iOS Live Activities

Документация Apple:
О Live Activities
Обновление и завершение Live Activities с помощью push-уведомлений ActivityKit

startLiveActivity

Используйте этот метод для создания iOS Live Activities.

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

Позволяет создавать iOS Live Activities.

Тело запроса

Параметр	Тип	Обязательный/Необязательный	Описание
application	String	Обязательный	Код приложения Pushwoosh
auth	String	Обязательный	Токен доступа к API из Панели управления Pushwoosh.
notifications	Array	Обязательный	JSON-массив параметров сообщения. Подробности см. в таблице Notifications ниже.

Notifications

Параметры, используемые в массиве notifications:

Параметр	Тип	Обязательный/Необязательный	Описание
content	String	Обязательный	Резервное содержимое для устройств с версией iOS ниже 16.1, которые не поддерживают Live Activity. На iOS 16.1+ (с поддержкой Live Activity) содержимое берется из поля `live_activity`.
title	String	Необязательный	Заголовок уведомления.
live_activity	Object	Обязательный	Данные Live Activity для создания Live Activity в iOS.
content-state	Object	Обязательный	Содержимое для уведомления Live Activity.
attributes-type	String	Обязательный	Тип атрибутов, используемых в Live Activity.
attributes	Object	Обязательный	Атрибуты для Live Activity.
live_activity_id	String	Обязательный	Уникальный идентификатор для Live Activity, созданный пользователем.
filter_code	String	Необязательный	Код фильтра (сегмента) для таргетинга на определенные сегменты аудитории.
devices	Массив строк	Необязательный	Токены или HWID для отправки целевых push-уведомлений, максимум 1000. Если параметр установлен, сообщение будет отправлено только устройствам из списка. Примечание: Использование Application Group для списка устройств не допускается, а push-токены iOS должны быть в нижнем регистре.
users	Массив строк	Необязательный	Если параметр установлен, сообщение будет доставлено только указанным User ID (назначенным через вызов `/registerUser`). В массив можно включить до 1000 User ID. Примечание: При использовании вместе с параметром `devices` параметр `users` будет иметь приоритет. Использование Application Group для списка пользователей не допускается.

Ответ

200

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

Пример запроса

{
  "request": {
    "application": "XXXXX-XXXXX",        // обязательно. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // обязательно. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "live_activity": {                 // обязательно. Данные Live Activity для создания Live Activity в iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // необязательно. Уникальный идентификатор Live Activity.
      "filter_code": "FILTER_NAME",      // необязательно. Укажите фильтр.
      "devices": [                       // необязательно. Укажите токены или HWID для отправки целевых push-уведомлений.
          "hwid_XXXX"                    //           Не более 1000 токенов/HWID в массиве.
      ],                                 //           Если параметр установлен, сообщение будет отправлено только
                                         //           устройствам из списка. Использование Application Group для
                                         //           списка устройств не допускается.
                                         //           Push-токены iOS могут быть только в нижнем регистре.
      "users": [                         // необязательно. Если установлено, сообщение будет доставлено только указанным
        "user_XXXX"                      //           User ID (установленным через вызов /registerUser). Если указан
      ]                                  //           вместе с параметром devices, последний будет проигнорирован.
                                         //           Не более 1000 User ID в массиве.
                                         //           Использование Application Group для списка пользователей не допускается.
    }]
  }
}

Примечание:
Прочитайте эту статью, чтобы узнать больше о работе с Live Activities с помощью Pushwoosh iOS SDK.

updateLiveActivity

Используйте этот метод для управления iOS Live Activities.

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

Позволяет управлять iOS Live Activities.

Тело запроса

Параметр	Тип	Обязательный/Необязательный	Описание
auth	String	Обязательный	Токен доступа к API из Панели управления Pushwoosh.
application	String	Обязательный	Код приложения Pushwoosh
notifications	Array	Обязательный	JSON-массив параметров сообщения. Подробности см. в таблице Notifications ниже.

Notifications

Параметры, используемые в массиве notifications:

Параметр	Тип	Обязательный/Необязательный	Описание
live_activity	Object	Обязательный	Данные Live Activity для обновления Live Activity в iOS.
event	String	Обязательный	Указывает тип события. Используйте `"update"`, чтобы обновить Live Activity, или `"end"`, чтобы ее завершить.
content-state	Object	Обязательный	Объект с парами “ключ-значение”, используемый для передачи данных в Live Activity для обновления ее содержимого.
dismissal-date	Integer	Необязательный	Время (в секундах), когда Live Activity должна завершиться.
live_activity_id	String	Обязательный	Уникальный идентификатор обновляемой Live Activity.
stale-date	Integer	Необязательный	Время (в секундах), которое представляет дату, когда Live Activity становится устаревшей.

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

Пример запроса

{
  "request": {
    "application": "XXXXX-XXXXX",        // обязательно. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // обязательно. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "live_activity": {                 // обязательно. Данные Live Activity для обновления Live Activity в iOS
        "event": "update",               // обязательно. Используйте "update" для обновления Live Activity или
                                         //           "end" для ее завершения
        "content-state": {               // обязательно. Объект с парами "ключ-значение" для передачи данных
          "courierName": "NUMBER: 15",   //           в Live Activity для обновления ее содержимого
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // необязательно. Время завершения Live Activity в секундах
        "stale-date": 23456789           // необязательно. Время (в секундах), когда Live Activity становится устаревшей
      },
      "live_activity_id": "unique UUID"  // необязательно. Уникальный идентификатор Live Activity.
    }]
  }
}

Прочитайте эту статью, чтобы узнать больше о работе с Live Activities с помощью Pushwoosh iOS SDK.