Class: Aws::Pinpoint::Types::MessageConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass MessageConfiguration data as a hash:

{
  adm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  apns_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  baidu_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  default_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  email_message: {
    body: "__string",
    from_address: "__string",
    html_body: "__string",
    title: "__string",
  },
  gcm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  sms_message: {
    body: "__string",
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    sender_id: "__string",
  },
}

Specifies the message configuration settings for a campaign.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#adm_message ⇒ Types::Message

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#apns_message ⇒ Types::Message

The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#baidu_message ⇒ Types::Message

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#default_message ⇒ Types::Message

The default message that the campaign sends through all the channels that are configured for the campaign.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#email_message ⇒ Types::CampaignEmailMessage

The message that the campaign sends through the email channel.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#gcm_message ⇒ Types::Message

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#sms_message ⇒ Types::CampaignSmsMessage

The message that the campaign sends through the SMS channel.

Returns:



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10717

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end