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

Inherits:

Struct

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

Defined in:

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

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The body of the SMS message.

• #entity_id ⇒ String

  The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

• #keyword ⇒ String

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

• #media_url ⇒ String

  This field is reserved for future use.

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

• #template_id ⇒ String

  The template ID received from the regulatory body for sending SMS in your country.

Instance Attribute Details

#body ⇒ String

The body of the SMS message.

Returns:

• (String)

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

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

#entity_id ⇒ String

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Returns:

• (String)

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions,
  :entity_id,
  :template_id)
  SENSITIVE = []
  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 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10729

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

#media_url ⇒ String

This field is reserved for future use.

Returns:

• (String)

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

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

#message_type ⇒ String

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)

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions,
  :entity_id,
  :template_id)
  SENSITIVE = []
  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.

Returns:

• (String)

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions,
  :entity_id,
  :template_id)
  SENSITIVE = []
  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.

Returns:

• (String)

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

class SMSMessage < Struct.new(
  :body,
  :keyword,
  :media_url,
  :message_type,
  :origination_number,
  :sender_id,
  :substitutions,
  :entity_id,
  :template_id)
  SENSITIVE = []
  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.

Returns:

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

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

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

#template_id ⇒ String

The template ID received from the regulatory body for sending SMS in your country.

Returns:

• (String)

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

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