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

Class: Aws::Pinpoint::Types::MessageRequest

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 MessageRequest data as a hash:

{
  addresses: {
    "__string" => {
      body_override: "__string",
      channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
      context: {
        "__string" => "__string",
      },
      raw_content: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      title_override: "__string",
    },
  },
  context: {
    "__string" => "__string",
  },
  message_configuration: {
    apns_message: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      badge: 1,
      body: "__string",
      category: "__string",
      data: {
        "__string" => "__string",
      },
      media_url: "__string",
      raw_content: "__string",
      silent_push: false,
      sound: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      thread_id: "__string",
      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",
    },
    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",
      raw_content: "__string",
      restricted_package_name: "__string",
      silent_push: false,
      small_image_icon_url: "__string",
      sound: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      title: "__string",
      url: "__string",
    },
    sms_message: {
      body: "__string",
      message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
      sender_id: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
    },
  },
}

Send message request.

Instance Attribute Summary collapse

Instance Attribute Details

#addressesHash<String,Types::AddressConfiguration>

A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

Returns:



3561
3562
3563
3564
3565
3566
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3561

class MessageRequest < Struct.new(
  :addresses,
  :context,
  :message_configuration)
  include Aws::Structure
end

#contextHash<String,String>

Returns:

  • (Hash<String,String>)


3561
3562
3563
3564
3565
3566
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3561

class MessageRequest < Struct.new(
  :addresses,
  :context,
  :message_configuration)
  include Aws::Structure
end

#message_configurationTypes::DirectMessageConfiguration

Message configuration.



3561
3562
3563
3564
3565
3566
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3561

class MessageRequest < Struct.new(
  :addresses,
  :context,
  :message_configuration)
  include Aws::Structure
end