Class: Aws::Pinpoint::Types::SMSMessageActivity

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

{
  message_config: {
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    origination_number: "__string",
    sender_id: "__string",
    entity_id: "__string",
    template_id: "__string",
  },
  next_activity: "__string",
  template_name: "__string",
  template_version: "__string",
}

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#message_config ⇒ Types::JourneySMSMessage

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

Returns:



13721
13722
13723
13724
13725
13726
13727
13728
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13721

class SMSMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_activity ⇒ String

The unique identifier for the next activity to perform, after the message is sent.

Returns:

  • (String) 


13721
13722
13723
13724
13725
13726
13727
13728
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13721

class SMSMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

Returns:

  • (String) 


13721
13722
13723
13724
13725
13726
13727
13728
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13721

class SMSMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#template_version ⇒ String

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the

Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Returns:

  • (String) 


13721
13722
13723
13724
13725
13726
13727
13728
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13721

class SMSMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end