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

Class: Aws::Pinpoint::Types::SendUsersMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SendUsersMessageRequest

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  context: {
    "__string" => "__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",
      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",
      collapse_id: "__string",
      data: {
        "__string" => "__string",
      },
      media_url: "__string",
      preferred_authentication_method: "__string",
      priority: "__string",
      raw_content: "__string",
      silent_push: false,
      sound: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      thread_id: "__string",
      time_to_live: 1,
      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",
      raw_content: "__string",
      silent_push: false,
      small_image_icon_url: "__string",
      sound: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      time_to_live: 1,
      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",
      priority: "__string",
      raw_content: "__string",
      restricted_package_name: "__string",
      silent_push: false,
      small_image_icon_url: "__string",
      sound: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      time_to_live: 1,
      title: "__string",
      url: "__string",
    },
    sms_message: {
      body: "__string",
      keyword: "__string",
      message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
      origination_number: "__string",
      sender_id: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
    },
  },
  users: {
    "__string" => {
      body_override: "__string",
      context: {
        "__string" => "__string",
      },
      raw_content: "__string",
      substitutions: {
        "__string" => ["__string"],
      },
      title_override: "__string",
    },
  },
}

Send message request.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #context ⇒ Hash<String,String>

  A map of custom attribute-value pairs.

• #message_configuration ⇒ Types::DirectMessageConfiguration

  Message definitions for the default message and any messages that are tailored for specific channels.

• #users ⇒ Hash<String,Types::EndpointSendConfiguration>

  A map that associates user IDs with EndpointSendConfiguration objects.

Instance Attribute Details

#context ⇒ Hash<String,String>

A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

Returns:

• (Hash<String,String>)

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

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :users)
  include Aws::Structure
end

#message_configuration ⇒ Types::DirectMessageConfiguration

Message definitions for the default message and any messages that are tailored for specific channels.

Returns:

• (Types::DirectMessageConfiguration)

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

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :users)
  include Aws::Structure
end

#users ⇒ Hash<String,Types::EndpointSendConfiguration>

A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

Returns:

• (Hash<String,Types::EndpointSendConfiguration>)

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

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :users)
  include Aws::Structure
end