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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_id ⇒ String

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

Returns:

  • (String) 


8945
8946
8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 8945

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


8945
8946
8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 8945

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

#origination_number ⇒ String

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) 


8945
8946
8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 8945

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

[1]: docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html

Returns:

  • (String) 


8945
8946
8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 8945

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


8945
8946
8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 8945

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