Class: Aws::PinpointSMSVoiceV2::Types::SendTextMessageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointSMSVoiceV2::Types::SendTextMessageRequest
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#configuration_set_name ⇒ String
The name of the configuration set to use.
-
#context ⇒ Hash<String,String>
You can specify custom data in this field.
-
#destination_country_parameters ⇒ Hash<String,String>
This field is used for any country-specific registration requirements.
-
#destination_phone_number ⇒ String
The destination phone number in E.164 format.
-
#dry_run ⇒ Boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
-
#keyword ⇒ String
When you register a short code in the US, you must specify a program name.
-
#max_price ⇒ String
The maximum amount that you want to spend, in US dollars, per each text message.
-
#message_body ⇒ String
The body of the text message.
-
#message_type ⇒ String
The type of message.
-
#origination_identity ⇒ String
The origination identity of the message.
-
#protect_configuration_id ⇒ String
The unique identifier for the protect configuration.
-
#time_to_live ⇒ Integer
How long the text message is valid for, in seconds.
Instance Attribute Details
#configuration_set_name ⇒ String
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#context ⇒ Hash<String,String>
You can specify custom data in this field. If you do, that data is logged to the event destination.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#destination_country_parameters ⇒ Hash<String,String>
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
IN_ENTITY_ID
The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.IN_TEMPLATE_ID
The template ID that you received after completing the sender ID registration process.Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#destination_phone_number ⇒ String
The destination phone number in E.164 format.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
When set to true, the message is checked and validated, but isn't
sent to the end recipient. You are not charged for using DryRun
.
The Message Parts per Second (MPS) limit when using DryRun
is
five. If your origination identity has a lower MPS limit then the
lower MPS limit is used. For more information about MPS limits, see
Message Parts per Second (MPS) limits in the AWS End User
Messaging SMS User Guide..
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#keyword ⇒ String
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#max_price ⇒ String
The maximum amount that you want to spend, in US dollars, per each
text message. If the calculated amount to send the text message is
greater than MaxPrice
, the message is not sent and an error is
returned.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#message_body ⇒ String
The body of the text message.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#message_type ⇒ String
The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#origination_identity ⇒ String
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#protect_configuration_id ⇒ String
The unique identifier for the protect configuration.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#time_to_live ⇒ Integer
How long the text message is valid for, in seconds. By default this
is 72 hours. If the messages isn't handed off before the TTL
expires we stop attempting to hand off the message and return
TTL_EXPIRED
event.
5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5591 class SendTextMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :message_type, :keyword, :configuration_set_name, :max_price, :time_to_live, :context, :destination_country_parameters, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |