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

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

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the SMS message.

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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

#entity_idString

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

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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

#sender_idString

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

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2975

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