iOS 实时活动 API

Apple 文档：

关于实时活动

使用 ActivityKit 推送通知更新和结束实时活动

startLiveActivity

使用此方法创建 iOS 实时活动。

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

允许创建 iOS 实时活动。

请求体

参数	类型	必填/可选	描述
application	字符串	必填	Pushwoosh application code (应用代码)
auth	字符串	必填	来自 Pushwoosh Control Panel 的 API access token (API 访问令牌)。
notifications	数组	必填	消息参数的 JSON 数组。详情请参见下方的 Notifications 表。

Notifications

在 notifications 数组中使用的参数：

参数	类型	必填/可选	描述
content	字符串	必填	为运行 iOS 16.1 以下版本且不支持实时活动的设备提供的备用内容。在 iOS 16.1+（支持实时活动）上，内容来源于 `live_activity` 字段。
title	字符串	可选	通知消息的标题。
live_activity	对象	必填	用于在 iOS 中创建实时活动的 Live Activity 数据。
content-state	对象	必填	实时活动通知的内容。
attributes-type	字符串	必填	实时活动中使用的属性类型。
attributes	对象	必填	实时活动的属性。
live_activity_id	字符串	必填	由用户创建的实时活动的唯一 ID。

响应

200

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

请求示例

{
  "request": {
    "application": "XXXXX-XXXXX",        // 必填。Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // 必填。来自 Pushwoosh Control Panel 的 API access token
    "notifications": [{
      "live_activity": {                 // 必填。用于在 iOS 中创建实时活动的 Live Activity 数据
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // 可选。实时活动的唯一标识符。
    }]
  }
}

注意：

阅读这篇文章，了解更多关于使用 Pushwoosh iOS SDK 处理实时活动的信息。

updateLiveActivity

使用此方法管理 iOS 实时活动。

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

允许创建和管理 iOS 实时活动。

请求体

参数	类型	必填/可选	描述
auth	字符串	必填	来自 Pushwoosh Control Panel 的 API access token (API 访问令牌)。
application	字符串	必填	Pushwoosh application code (应用代码)
notifications	数组	必填	消息参数的 JSON 数组。详情请参见下方的 Notifications 表。

Notifications

在 notifications 数组中使用的参数：

参数	类型	必填/可选	描述
live_activity	对象	必填	用于在 iOS 中更新实时活动的 Live Activity 数据。
event	字符串	必填	指定事件类型。使用 `"update"` 更新实时活动，或使用 `"end"` 关闭它。
content-state	对象	必填	包含键值对的对象，用于将数据传递给实时活动以更新其内容。
dismissal-date	整数	可选	实时活动应结束的时间（以秒为单位）。
live_activity_id	字符串	必填	正在更新的实时活动的唯一标识符。
relevance-score	整数	可选	告知 iOS 系统哪个实时活动比其他活动具有更高的优先级。接受从 1 到无穷大的值（建议使用最高 100 的值）。
stale-date	整数	可选	表示实时活动变为过时或过期的日期的时间（以秒为单位）。

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

请求示例

{
  "request": {
    "application": "XXXXX-XXXXX",        // 必填。Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // 必填。来自 Pushwoosh Control Panel 的 API access token
    "notifications": [{
      "live_activity": {                 // 必填。用于在 iOS 中更新实时活动的 Live Activity 数据
        "event": "update",               // 必填。使用 "update" 更新实时活动或
                                         //           使用 "end" 关闭实时活动
        "content-state": {               // 必填。包含键值对的对象，用于传递数据
          "courierName": "NUMBER: 15",   //           以更新实时活动的内容
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // 可选。实时活动结束的时间，以秒为单位
        "relevance-score": 50,           // 可选。实时活动的优先级（建议 1 到 100）
        "stale-date": 23456789           // 可选。实时活动变为过时的时间（以秒为单位）
      },
      "live_activity_id": "unique UUID"  // 可选。实时活动的唯一标识符。
    }]
  }
}

阅读这篇文章，了解更多关于使用 Pushwoosh iOS SDK 处理实时活动的信息。