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

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

SMS Message.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The message body of the notification, the email body or the text message.

Returns:

  • (String)


5928
5929
5930
5931
5932
5933
5934
5935
# File 'lib/aws-sdk-pinpoint/types.rb', line 5928

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

#message_typeString

Is this a transaction priority message or lower priority.

Returns:

  • (String)


5928
5929
5930
5931
5932
5933
5934
5935
# File 'lib/aws-sdk-pinpoint/types.rb', line 5928

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

#origination_numberString

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)


5928
5929
5930
5931
5932
5933
5934
5935
# File 'lib/aws-sdk-pinpoint/types.rb', line 5928

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

#sender_idString

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)


5928
5929
5930
5931
5932
5933
5934
5935
# File 'lib/aws-sdk-pinpoint/types.rb', line 5928

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

#substitutionsHash<String,Array<String>>

Returns:

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


5928
5929
5930
5931
5932
5933
5934
5935
# File 'lib/aws-sdk-pinpoint/types.rb', line 5928

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