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

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 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the SMS message.

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#keywordString

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

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#media_urlString

This field is reserved for future use.

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#message_typeString

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#origination_numberString

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.

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#sender_idString

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.

Returns:

  • (String)


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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

#substitutionsHash<String,Array<String>>

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

Returns:

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


13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13544

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