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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 part.

• #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.

• #time_to_live ⇒ Integer

  How long the text message is valid for.

Instance Attribute Details

#configuration_set_name ⇒ String

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_phone_number ⇒ String

The destination phone number in E.164 format.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end

#max_price ⇒ String

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end

#message_body ⇒ String

The body of the text message.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end

#message_type ⇒ String

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end

#time_to_live ⇒ Integer

How long the text message is valid for. By default this is 72 hours.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2690

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)
  SENSITIVE = []
  include Aws::Structure
end