使用特定于平台的有效载荷发布 Amazon SNS 通知
您可以使用 Amazon Web Services 管理控制台 或 Amazon SNS API 将自定义消息以及平台特定的负载发送到移动设备。有关使用 Amazon SNS API 的信息,请参阅 移动推送 API 操作 和 snsmobilepush.zip 中的 SNSMobilePush.java 文件。
发送 JSON 格式化的消息
在发送平台特定的负载时,数据必须格式化为 JSON 键-值对字符串(用引号进行转义)。
下面的示例显示 FCM 平台的一条自定义消息。
{ "GCM": "{\"fcmV1Message\": {\"message\": {\"notification\": {\"title\": \"Hello\", \"body\": \"This is a test.\"}, \"data\": {\"dataKey\": \"example\"}}}}" }
发送平台特定的消息
除了以键-值对形式发送自定义数据之外,您还可以发送平台特定的键-值对。
以下示例显示如何在 FCM data 参数中的自定义数据键-值对之后加入 FCM 参数 time_to_live 和 collapse_key。
{ "GCM": "{\"fcmV1Message\": {\"message\": {\"notification\": {\"title\": \"TitleTest\", \"body\": \"Sample message for Android or iOS endpoints.\"}, \"data\":{\"time_to_live\": 3600,\"collapse_key\":\"deals\"}}}}" }
有关 Amazon SNS 中支持的每个推送通知服务所支持的键-值对列表,请参阅以下内容:
重要
Amazon SNS 现在支持 Firebase Cloud Messaging(FCM)HTTP v1 API,用于向 Android 设备发送移动推送通知。
2024 年 3 月 26 日 – Amazon SNS 支持适用于 Apple 设备和 Webpush 目的地的 FCM HTTP v1 API。我们建议您在 2024 年 6 月 1 日或之前将现有的移动推送应用程序迁移到最新的 FCM HTTP v1 API,以避免应用程序中断。
-
APN 文档中的负载密钥参考
-
FCM 文档中的 Firebase 云消息收发 HTTP 协议
-
ADM 文档中的发送消息
在多个平台上向应用程序发送消息
要为多个平台(如 FCM 和 APNs)向设备上安装的应用程序发送消息,必须先使移动终端节点订阅 Amazon SNS 中的某个主题,然后向该主题发布消息。
以下示例显示在 APNs、FCM 和 ADM 上发送给已订阅的移动终端节点的消息。
{ "default": "This is the default message which must be present when publishing a message to a topic. The default message will only be used if a message is not present for one of the notification platforms.", "APNS": "{\"aps\":{\"alert\": \"Check out these awesome deals!\",\"url\":\"www.amazon.com\"} }", "GCM": "{\"data\":{\"message\":\"Check out these awesome deals!\",\"url\":\"www.amazon.com\"}}", "ADM": "{\"data\":{\"message\":\"Check out these awesome deals!\",\"url\":\"www.amazon.com\"}}" }
将消息作为警报或后台通知发送到 APNs
Amazon SNS 可以将消息发送到 APNs 作为 alert 或 background 通知(有关更多信息,请参阅 APNs 文档中的将后台更新推送到您的应用程序
-
alertAPNs 通知通过显示警告消息、播放声音或向应用程序的图标添加徽章来通知用户。 -
backgroundAPNs 通知将唤醒或指示应用程序根据通知的内容进行操作,而不通知用户。
指定自定义 APNs 标头值
我们建议使用 Amazon SNS Publish API 操作、Amazon 开发工具包或 Amazon CLI 为 AWS.SNS.MOBILE.APNS.PUSH_TYPE 预留的消息属性指定自定义值。以下 CLI 示例为指定的主题将 content-available 设置为 1 并将 apns-push-type 设置为 background。
aws sns publish \ --endpoint-url https://sns.us-east-1.amazonaws.com \ --target-arn arn:aws:sns:us-east-1:123456789012:endpoint/APNS_PLATFORM/MYAPP/1234a567-bc89-012d-3e45-6fg7h890123i \ --message '{"APNS_PLATFORM":"{\"aps\":{\"content-available\":1}}"}' \ --message-attributes '{ \ "AWS.SNS.MOBILE.APNS.TOPIC":{"DataType":"String","StringValue":"com.amazon.mobile.messaging.myapp"}, \ "AWS.SNS.MOBILE.APNS.PUSH_TYPE":{"DataType":"String","StringValue":"background"}, \ "AWS.SNS.MOBILE.APNS.PRIORITY":{"DataType":"String","StringValue":"5"}}' \ --message-structure json
注意
确保 JSON 结构有效。在每个键/值对(最后一个除外)后面添加一个逗号。
从负载推断 APNs 推送类型标头
如果您没有设置 apns-push-type APNs 标头,Amazon SNS 将标头设置为 alert 或 background,具体取决于 JSON 格式的 APNs 有效负载配置的 aps 字典中的 content-available 键。
注意
Amazon SNS 只能推断 background 或 alert 标头,尽管 apns-push-type 标头可以设置为其他值。
-
apns-push-type设置为alert。-
如果
aps字典包含设置为1的content-available和一个或多个触发用户交互的键。 -
如果
aps字典包含设置为0的content-available或如果content-available密钥不存在。 -
如果
content-available键的值不是整数或布尔值。
-
-
apns-push-type设置为background。-
如果
aps字典仅包含设置为1的content-available且不包含触发用户交互的其他键。重要
如果 Amazon SNS 发送 APNs 的原始配置对象以作为仅后台通知,则必须在
aps字典中包括设置为1的content-available。尽管您可以包含自定义键,但aps字典不得包含触发用户交互的任何键(例如,警报、徽章或声音)。
-
下面是一个示例原始配置对象。
{ "APNS": "{\"aps\":{\"content-available\":1},\"Foo1\":\"Bar\",\"Foo2\":123}" }
在此示例中,Amazon SNS 针对消息将 apns-push-type APNs 标头设置为 background。当 Amazon SNS 检测到 apn 字典包含设置为 1 的 content-available 键—并且不包含任何其他可触发用户交互的键时—它将标题设置为 background。