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.

Тело запроса (Request body)

Параметр	Тип	Обязательный/Опциональный	Описание
application	String	Обязательный	Код приложения Pushwoosh
auth	String	Обязательный	API access token из панели управления 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, созданный пользователем.
filter_code	String	Опциональный	Код фильтра (сегмента) для таргетинга на определенные сегменты аудитории.
devices	Array of strings	Опциональный	Токены или HWID для отправки таргетированных push-уведомлений (максимум 1000). Если задано, сообщение будет отправлено только на устройства из списка. Примечание: Использование Application Group для списка устройств не допускается, а push-токены iOS должны быть в нижнем регистре.
users	Array of strings	Опциональный	Если задано, сообщение будет доставлено только указанным User ID (назначенным через вызов /registerUser). Вы можете включить в массив до 1000 User ID. Примечание: При совместном использовании с параметром devices, параметр users будет иметь приоритет. Использование Application Group для списка пользователей не допускается.

Ответ (Response)

200

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

Пример запроса (Request example)

{
  "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.
      "filter_code": "FILTER_NAME",      // optional. Specify filter.
      "devices": [                       // optional. Specify tokens or hwids to send targeted push
          "hwid_XXXX"                    //           notifications. Not more than 1000 tokens/hwids in
      ],                                 //           an array. If set, the message will only be sent to
                                         //           the devices on the list. Application Group for
                                         //           devices list is not allowed.
                                         //           iOS push tokens can only be lower case.
      "users": [                         // optional. If set, message will only be delivered to the specified
        "user_XXXX"                      //           user ID's (set via /registerUser call). If specified
      ]                                  //           together with devices parameter, the latter will be
                                         //           ignored. Not more than 1000 user ID's in an array.
                                         //           Application Group for users list is not allowed.
    }]
  }
}

Примечание:

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

updateLiveActivity

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

Примечание

Документация Apple:

• О Live Activities
• Обновление и завершение Live Activities с помощью push-уведомлений ActivityKit

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

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

Тело запроса (Request body)

Параметр	Тип	Обязательный/Опциональный	Описание
auth	String	Обязательный	API access token из панели управления 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 становится неактуальным (stale).

200

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

Пример запроса (Request example)

{
  "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
        "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.