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

Class: Aws::Pinpoint::Types::SendMessagesRequest

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

{
  application_id: "__string", # required
  message_request: { # required
    addresses: {
      "__string" => {
        body_override: "__string",
        channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
        context: {
          "__string" => "__string",
        },
        raw_content: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        title_override: "__string",
      },
    },
    campaign: {
      "__string" => "__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",
        json_data: "__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",
        data: {
          "__string" => "__string",
        },
        json_data: "__string",
        media_url: "__string",
        preferred_authentication_method: "__string",
        raw_content: "__string",
        silent_push: false,
        sound: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        thread_id: "__string",
        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",
        json_data: "__string",
        raw_content: "__string",
        silent_push: false,
        small_image_icon_url: "__string",
        sound: "__string",
        substitutions: {
          "__string" => ["__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",
        },
        json_data: "__string",
        silent_push: false,
        substitutions: {
          "__string" => ["__string"],
        },
        title: "__string",
        url: "__string",
      },
      email_message: {
        body: "__string",
        from_address: "__string",
        html_body: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        template_arn: "__string",
        title: "__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",
        json_data: "__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"],
        },
      },
    },
    request_id: "__string",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

Returns:

  • (String)


5593
5594
5595
5596
5597
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5593

class SendMessagesRequest < Struct.new(
  :application_id,
  :message_request)
  include Aws::Structure
end

#message_requestTypes::MessageRequest

Send message request.



5593
5594
5595
5596
5597
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5593

class SendMessagesRequest < Struct.new(
  :application_id,
  :message_request)
  include Aws::Structure
end