Class: Aws::PinpointSMSVoiceV2::Types::SendNotifyTextMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::SendNotifyTextMessageRequest

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

• #message_feedback_enabled ⇒ Boolean

  Set to true to enable message feedback for the message.

• #notify_configuration_id ⇒ String

  The unique identifier of the notify configuration to use for sending the message.

• #template_id ⇒ String

  The unique identifier of the template to use for the message.

• #template_variables ⇒ Hash<String,String>

  A map of template variable names and their values.

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

Returns:

• (String)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  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 8382

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  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 8382

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  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 8382

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#message_feedback_enabled ⇒ Boolean

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

Returns:

• (Boolean)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#notify_configuration_id ⇒ String

The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.

Returns:

• (String)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#template_id ⇒ String

The unique identifier of the template to use for the message.

Returns:

• (String)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#template_variables ⇒ Hash<String,String>

A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".

Returns:

• (Hash<String,String>)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  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.

Returns:

• (Integer)

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

class SendNotifyTextMessageRequest < Struct.new(
  :notify_configuration_id,
  :destination_phone_number,
  :template_id,
  :template_variables,
  :time_to_live,
  :context,
  :configuration_set_name,
  :dry_run,
  :message_feedback_enabled)
  SENSITIVE = []
  include Aws::Structure
end