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",
  message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
  origination_number: "__string",
  sender_id: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
}

SMS Message.

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.

• #message_type ⇒ String

  Is this a transaction priority message or lower priority.

• #origination_number ⇒ String

  The phone number that the SMS message originates from.

• #sender_id ⇒ String

  The sender ID that is shown as the message sender on the recipient’s device.

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

  Default message substitutions.

Instance Attribute Details

#body ⇒ String

The body of the SMS message.

Returns:

• (String)

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :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.

Returns:

• (String)

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

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

#message_type ⇒ String

Is this a transaction priority message or lower priority.

Returns:

• (String)

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

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

#origination_number ⇒ String

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns:

• (String)

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

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

#sender_id ⇒ String

The sender ID that is shown as the message sender on the recipient’s device. Support for sender IDs varies by country or region.

Returns:

• (String)

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

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

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

Default message substitutions. Can be overridden by individual address substitutions.

Returns:

• (Hash<String,Array<String>>)

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

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