Class: Aws::Pinpoint::Types::MessageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::MessageRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass MessageRequest data as a hash:
{
addresses: {
"__string" => {
body_override: "__string",
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
},
},
context: {
"__string" => "__string",
},
endpoints: {
"__string" => {
body_override: "__string",
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
},
},
message_configuration: {
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: {
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",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
origination_number: "__string",
sender_id: "__string",
substitutions: {
"__string" => ["__string"],
},
},
voice_message: {
body: "__string",
language_code: "__string",
origination_number: "__string",
substitutions: {
"__string" => ["__string"],
},
voice_id: "__string",
},
},
trace_id: "__string",
}
Send message request.
Instance Attribute Summary collapse
-
#addresses ⇒ Hash<String,Types::AddressConfiguration>
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
-
#context ⇒ Hash<String,String>
A map of custom attributes to attributes to be attached to the message.
-
#endpoints ⇒ Hash<String,Types::EndpointSendConfiguration>
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
-
#message_configuration ⇒ Types::DirectMessageConfiguration
Message configuration.
-
#trace_id ⇒ String
A unique ID that you can use to trace a message.
Instance Attribute Details
#addresses ⇒ Hash<String,Types::AddressConfiguration>
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.
6818 6819 6820 6821 6822 6823 6824 6825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 6818 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :trace_id) include Aws::Structure end |
#context ⇒ Hash<String,String>
A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification’s ‘data.pinpoint’ object or added to the email/sms delivery receipt event attributes.
6818 6819 6820 6821 6822 6823 6824 6825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 6818 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :trace_id) include Aws::Structure end |
#endpoints ⇒ Hash<String,Types::EndpointSendConfiguration>
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
6818 6819 6820 6821 6822 6823 6824 6825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 6818 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :trace_id) include Aws::Structure end |
#message_configuration ⇒ Types::DirectMessageConfiguration
Message configuration.
6818 6819 6820 6821 6822 6823 6824 6825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 6818 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :trace_id) include Aws::Structure end |
#trace_id ⇒ String
A unique ID that you can use to trace a message. This ID is visible to recipients.
6818 6819 6820 6821 6822 6823 6824 6825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 6818 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :trace_id) include Aws::Structure end |