Class: Aws::Pinpoint::Types::CampaignSmsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CampaignSmsMessage
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
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
-
#body ⇒ String
The body of the SMS message.
-
#entity_id ⇒ String
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
-
#message_type ⇒ String
The SMS message type.
-
#origination_number ⇒ String
The long code to send the SMS message from.
-
#sender_id ⇒ String
The sender ID to display on recipients' devices when they receive the SMS message.
-
#template_id ⇒ String
The template ID received from the regulatory body for sending SMS in your country.
Instance Attribute Details
#body ⇒ String
The body of the SMS message.
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_id ⇒ String
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
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_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).
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_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.
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_id ⇒ String
The sender ID to display on recipients' devices when they receive the SMS message.
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_id ⇒ String
The template ID received from the regulatory body for sending SMS in your country.
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 |