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	Обязательный	Уникальный ID для Live Activity, созданный пользователем.

Ответ

200

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

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

{
  "request": {
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // required. Live Activity data to create Live Activity in iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // optional. Unique identifier of the Live Activity.
    }]
  }
}

Примечание:

Прочтите эту статью, чтобы узнать больше о работе с 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.
relevance-score	Integer	Необязательный	Сообщает системе iOS, какой Live Activity имеет более высокий приоритет по сравнению с другими. Принимает значения от 1 до бесконечности (рекомендуются значения до 100).
stale-date	Integer	Необязательный	Время (в секундах), представляющее дату, когда Live Activity становится устаревшим или неактуальным.

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

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

{
  "request": {
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // required. Live Activity data to update Live Activity in iOS
        "event": "update",               // required. Use "update" to update Live Activity or
                                         //           "end" to close Live Activity
        "content-state": {               // required. Object with key-value pairs used to pass data
          "courierName": "NUMBER: 15",   //           to Live Activity for updating its content
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // optional. Time of ending Live Activity in seconds
        "relevance-score": 50,           // optional. Priority for the Live Activity (1 to 100 recommended)
        "stale-date": 23456789           // optional. Time (in seconds) when Live Activity becomes stale
      },
      "live_activity_id": "unique UUID"  // optional. Unique identifier of the Live Activity.
    }]
  }
}

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