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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::MessageConfiguration

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:

{
  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,
    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,
    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,
    title: "__string",
    url: "__string",
  },
  sms_message: {
    body: "__string",
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    sender_id: "__string",
  },
}

Message configuration for a campaign.

Instance Attribute Summary

• #apns_message ⇒ Types::Message

  The message that the campaign delivers to APNS channels.

• #default_message ⇒ Types::Message

  The default message for all channels.

• #email_message ⇒ Types::CampaignEmailMessage

  The email message configuration.

• #gcm_message ⇒ Types::Message

  The message that the campaign delivers to GCM channels.

• #sms_message ⇒ Types::CampaignSmsMessage

  The SMS message configuration.

Instance Attribute Details

#apns_message ⇒ Types::Message

The message that the campaign delivers to APNS channels. Overrides the default message.

Returns:

• (Types::Message)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3445

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

#default_message ⇒ Types::Message

The default message for all channels.

Returns:

• (Types::Message)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3445

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

#email_message ⇒ Types::CampaignEmailMessage

The email message configuration.

Returns:

• (Types::CampaignEmailMessage)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3445

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

#gcm_message ⇒ Types::Message

The message that the campaign delivers to GCM channels. Overrides the default message.

Returns:

• (Types::Message)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3445

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

#sms_message ⇒ Types::CampaignSmsMessage

The SMS message configuration.

Returns:

• (Types::CampaignSmsMessage)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3445

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