Class: Aws::Pinpoint::Types::DirectMessageConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::DirectMessageConfiguration
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass DirectMessageConfiguration data as a hash:
{
adm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
consolidation_key: "__string",
data: {
"__string" => "__string",
},
expires_after: "__string",
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
md5: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
apns_message: {
apns_push_type: "__string",
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
badge: 1,
body: "__string",
category: "__string",
collapse_id: "__string",
data: {
"__string" => "__string",
},
media_url: "__string",
preferred_authentication_method: "__string",
priority: "__string",
raw_content: "__string",
silent_push: false,
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
thread_id: "__string",
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
default_message: {
body: "__string",
substitutions: {
"__string" => ["__string"],
},
},
default_push_notification_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
silent_push: false,
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
email_message: {
body: "__string",
feedback_forwarding_address: "__string",
from_address: "__string",
raw_email: {
data: "data",
},
reply_to_addresses: ["__string"],
simple_email: {
html_part: {
charset: "__string",
data: "__string",
},
subject: {
charset: "__string",
data: "__string",
},
text_part: {
charset: "__string",
data: "__string",
},
},
substitutions: {
"__string" => ["__string"],
},
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
collapse_key: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
priority: "__string",
raw_content: "__string",
restricted_package_name: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
keyword: "__string",
media_url: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
origination_number: "__string",
sender_id: "__string",
substitutions: {
"__string" => ["__string"],
},
entity_id: "__string",
template_id: "__string",
},
voice_message: {
body: "__string",
language_code: "__string",
origination_number: "__string",
substitutions: {
"__string" => ["__string"],
},
voice_id: "__string",
},
}
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#adm_message ⇒ Types::ADMMessage
The default push notification message for the ADM (Amazon Device Messaging) channel.
-
#apns_message ⇒ Types::APNSMessage
The default push notification message for the APNs (Apple Push Notification service) channel.
-
#baidu_message ⇒ Types::BaiduMessage
The default push notification message for the Baidu (Baidu Cloud Push) channel.
-
#default_message ⇒ Types::DefaultMessage
The default message for all channels.
-
#default_push_notification_message ⇒ Types::DefaultPushNotificationMessage
The default push notification message for all push notification channels.
-
#email_message ⇒ Types::EmailMessage
The default message for the email channel.
-
#gcm_message ⇒ Types::GCMMessage
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
-
#sms_message ⇒ Types::SMSMessage
The default message for the SMS channel.
-
#voice_message ⇒ Types::VoiceMessage
The default message for the voice channel.
Instance Attribute Details
#adm_message ⇒ Types::ADMMessage
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#apns_message ⇒ Types::APNSMessage
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#baidu_message ⇒ Types::BaiduMessage
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#default_message ⇒ Types::DefaultMessage
The default message for all channels.
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#default_push_notification_message ⇒ Types::DefaultPushNotificationMessage
The default push notification message for all push notification channels.
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#email_message ⇒ Types::EmailMessage
The default message for the email channel. This message overrides the default message (DefaultMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#gcm_message ⇒ Types::GCMMessage
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#sms_message ⇒ Types::SMSMessage
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |
#voice_message ⇒ Types::VoiceMessage
The default message for the voice channel. This message overrides the default message (DefaultMessage).
6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6610 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :email_message, :gcm_message, :sms_message, :voice_message) SENSITIVE = [] include Aws::Structure end |