Class: Aws::Pinpoint::Types::SMSMessage

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SMSMessage

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  body: "__string",
  keyword: "__string",
  media_url: "__string",
  message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
  origination_number: "__string",
  sender_id: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
}

Specifies the default settings for a one-time SMS message that’s sent directly to an endpoint.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #body ⇒ String

  The body of the SMS message.

• #keyword ⇒ String

  The SMS program name that you provided to AWS Support when you requested your dedicated number.

• #media_url ⇒ String

  The URL of an image or video to display in the SMS message.

• #message_type ⇒ String

  The SMS message type.

• #origination_number ⇒ String

  The number to send the SMS message from.

• #sender_id ⇒ String

  The sender ID to display as the sender of the message on a recipient’s device.

• #substitutions ⇒ Hash<String,Array<String>>

  The message variables to use in the SMS message.

Instance Attribute Details

#body ⇒ String

The body of the SMS message.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#keyword ⇒ String

The SMS program name that you provided to AWS Support when you requested your dedicated number.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#media_url ⇒ String

The URL of an image or video to display in the SMS message.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#message_type ⇒ String

The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#origination_number ⇒ String

The number to send the SMS message from. This value should be one of the dedicated long or short codes that’s assigned to your AWS account. If you don’t specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#sender_id ⇒ String

The sender ID to display as the sender of the message on a recipient’s device. Support for sender IDs varies by country or region.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end

#substitutions ⇒ Hash<String,Array<String>>

The message variables to use in the SMS message. You can override the default variables with individual address variables.

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions)
  include Aws::Structure
end