You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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 collapse

Instance Attribute Details

#apns_messageTypes::Message

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

Returns:



4529
4530
4531
4532
4533
4534
4535
4536
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4529

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

#default_messageTypes::Message

The default message for all channels.

Returns:



4529
4530
4531
4532
4533
4534
4535
4536
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4529

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

#email_messageTypes::CampaignEmailMessage

The email message configuration.



4529
4530
4531
4532
4533
4534
4535
4536
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4529

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

#gcm_messageTypes::Message

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

Returns:



4529
4530
4531
4532
4533
4534
4535
4536
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4529

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

#sms_messageTypes::CampaignSmsMessage

The SMS message configuration.



4529
4530
4531
4532
4533
4534
4535
4536
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4529

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