Class: Aws::Pinpoint::Types::CampaignSmsMessage

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

Overview

Specifies the content and settings for an SMS message that’s sent to recipients of a campaign.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#body ⇒ String

The body of the SMS message.

Returns:

  • (String) 


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

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


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

class CampaignSmsMessage < Struct.new(
  :body,
  :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) 


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

class CampaignSmsMessage < Struct.new(
  :body,
  :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) 


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

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

#sender_id ⇒ String

The sender ID to display on recipients’ devices when they receive the SMS message.

Returns:

  • (String) 


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

class CampaignSmsMessage < Struct.new(
  :body,
  :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) 


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 2412

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