Class: Aws::Pinpoint::Types::JourneySMSMessage

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 JourneySMSMessage data as a hash:

{
  message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
  origination_number: "__string",
  sender_id: "__string",
  entity_id: "__string",
  template_id: "__string",
}

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_idString

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

Returns:

  • (String)


11021
11022
11023
11024
11025
11026
11027
11028
11029
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11021

class JourneySMSMessage < Struct.new(
  :message_type,
  :origination_number,
  :sender_id,
  :entity_id,
  :template_id)
  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)


11021
11022
11023
11024
11025
11026
11027
11028
11029
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11021

class JourneySMSMessage < Struct.new(
  :message_type,
  :origination_number,
  :sender_id,
  :entity_id,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#origination_numberString

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

Returns:

  • (String)


11021
11022
11023
11024
11025
11026
11027
11028
11029
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11021

class JourneySMSMessage < Struct.new(
  :message_type,
  :origination_number,
  :sender_id,
  :entity_id,
  :template_id)
  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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

Returns:

  • (String)


11021
11022
11023
11024
11025
11026
11027
11028
11029
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11021

class JourneySMSMessage < Struct.new(
  :message_type,
  :origination_number,
  :sender_id,
  :entity_id,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_idString

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

Returns:

  • (String)


11021
11022
11023
11024
11025
11026
11027
11028
11029
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11021

class JourneySMSMessage < Struct.new(
  :message_type,
  :origination_number,
  :sender_id,
  :entity_id,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end