AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SMSMessage as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the SMS message.

Returns:

  • (String)

    The body of the SMS message.

#keywordString

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

Returns:

  • (String)

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

#media_urlString

This field is reserved for future use.

Returns:

  • (String)

    This field is reserved for future use.

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

Possible values:

  • TRANSACTIONAL
  • PROMOTIONAL

Returns:

  • (String)

    The SMS message type.

#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)

    The number to send the SMS message from.

#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)

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

#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>>)

    The message variables to use in the SMS message.